diff --git a/examples/README.md b/examples/README.md deleted file mode 100644 index 83bf280df0c..00000000000 --- a/examples/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Exploration by Example - -The projects and tutorials below will show you how -to use Serenity.js and the Screenplay Pattern with: - -- [Protractor and Cucumber.js](todomvc-protractor-cucumber/) -- [Protractor and Mocha](todomvc-protractor-mocha/) \ No newline at end of file diff --git a/examples/todomvc-model/.gitignore b/examples/todomvc-model/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/examples/todomvc-model/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/examples/todomvc-model/.npmignore b/examples/todomvc-model/.npmignore deleted file mode 100644 index b512c09d476..00000000000 --- a/examples/todomvc-model/.npmignore +++ /dev/null @@ -1 +0,0 @@ -node_modules \ No newline at end of file diff --git a/examples/todomvc-model/package.json b/examples/todomvc-model/package.json deleted file mode 100644 index 41c9a442f50..00000000000 --- a/examples/todomvc-model/package.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "name": "todomvc-model", - "version": "0.0.0", - "description": "A test model of the Todo MVC application, representing the business tasks, questions and UI elements", - "main": "lib/index.js", - "typings": "lib/index.d.ts", - "scripts": { - "clean": "rimraf lib", - "package": "tsc --project tsconfig.json", - "rebuild": "npm run clean && npm run package" - }, - "author": "Jan Molak ", - "license": "Apache-2.0", - "dependencies": {}, - "peerDependencies": { - "serenity-js": "file:../../packages/serenity-js" - }, - "devDependencies": { - "@types/chai": "3.4.34", - "@types/chai-as-promised": "0.0.29", - "@types/node": "6.0.53", - "chai": "3.5.0", - "chai-as-promised": "5.3.0", - "protractor": "5.1.1", - "rimraf": "2.5.4", - "serenity-js": "file:../../packages/serenity-js", - "typescript": "2.1.4" - } -} diff --git a/examples/todomvc-model/rebuild-serenity-js b/examples/todomvc-model/rebuild-serenity-js deleted file mode 100755 index e63f8deb257..00000000000 --- a/examples/todomvc-model/rebuild-serenity-js +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -rm -rf node_modules/serenity-js -rm -rf ~/.npm/serenity-js - -pushd ../../packages/serenity-js -npm run rebuild -popd - -npm install diff --git a/examples/todomvc-model/src/actors.ts b/examples/todomvc-model/src/actors.ts deleted file mode 100644 index 7a7c526c030..00000000000 --- a/examples/todomvc-model/src/actors.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { protractor } from 'protractor'; -import { Actor, BrowseTheWeb, Cast } from 'serenity-js/lib/screenplay-protractor'; - -// note: it's important to use `protractor.browser` not simply `browser` -// a bug in Protractor makes the latter to fail upon a browser restart -// see: https://github.com/angular/protractor/issues/2001 - -export class Actors implements Cast { - actor(name: string): Actor { - return Actor.named(name).whoCan(BrowseTheWeb.using(protractor.browser)); - } -} diff --git a/examples/todomvc-model/src/index.ts b/examples/todomvc-model/src/index.ts deleted file mode 100644 index 96dc7bff663..00000000000 --- a/examples/todomvc-model/src/index.ts +++ /dev/null @@ -1,4 +0,0 @@ -export * from './questions'; -export * from './tasks'; -export * from './user_interface'; -export * from './actors'; diff --git a/examples/todomvc-model/src/questions/index.ts b/examples/todomvc-model/src/questions/index.ts deleted file mode 100644 index 917da6bf3d7..00000000000 --- a/examples/todomvc-model/src/questions/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -export { ItemStatus } from './item_status'; -export { TodoListItems } from './todo_list_items'; diff --git a/examples/todomvc-model/src/questions/item_status.ts b/examples/todomvc-model/src/questions/item_status.ts deleted file mode 100644 index 011eb2d1e61..00000000000 --- a/examples/todomvc-model/src/questions/item_status.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { Question, UsesAbilities } from 'serenity-js/lib/screenplay'; -import { BrowseTheWeb } from 'serenity-js/lib/serenity-protractor'; - -import { TodoList } from '../user_interface'; - -export class ItemStatus implements Question> { - static of(itemName: string) { - return new ItemStatus(itemName); - } - - answeredBy(actor: UsesAbilities): PromiseLike { - return BrowseTheWeb.as(actor) - .locate(TodoList.Complete_Item_Checkbox.of(this.itemName)) - .isSelected() - .then(selected => selected ? 'completed' : 'active'); - } - - constructor(private itemName: string) { - } - - toString = () => `the status of '${ this.itemName}'`; -} diff --git a/examples/todomvc-model/src/questions/todo_list_items.ts b/examples/todomvc-model/src/questions/todo_list_items.ts deleted file mode 100644 index 76f90f671ec..00000000000 --- a/examples/todomvc-model/src/questions/todo_list_items.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { Question, Text } from 'serenity-js/lib/screenplay-protractor'; - -import { TodoList } from '../user_interface/todo_list'; - -export class TodoListItems { - static Displayed: Question = Text.ofAll(TodoList.Items); -} diff --git a/examples/todomvc-model/src/tasks/add_a_todo_item.ts b/examples/todomvc-model/src/tasks/add_a_todo_item.ts deleted file mode 100644 index af66b8f2728..00000000000 --- a/examples/todomvc-model/src/tasks/add_a_todo_item.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { protractor } from 'protractor'; -import { Enter, PerformsTasks, step, Task } from 'serenity-js/lib/screenplay-protractor'; - -import { TodoList } from '../user_interface/todo_list'; - -export class AddATodoItem implements Task { - - public static called(name: string): AddATodoItem { - return new AddATodoItem(name); - } - - @step('{0} adds a todo item called "#name"') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - Enter.theValue(this.name) - .into(TodoList.What_Needs_To_Be_Done) - .thenHit(protractor.Key.ENTER) - ); - } - - constructor(private name: string) { - } -} diff --git a/examples/todomvc-model/src/tasks/add_todo_items.ts b/examples/todomvc-model/src/tasks/add_todo_items.ts deleted file mode 100644 index fc5328b9fc8..00000000000 --- a/examples/todomvc-model/src/tasks/add_todo_items.ts +++ /dev/null @@ -1,29 +0,0 @@ -import { PerformsTasks, step, Task } from 'serenity-js/lib/screenplay-protractor'; - -import { AddATodoItem } from './add_a_todo_item'; - -export class AddTodoItems implements Task { - - static called(names: string[]): AddTodoItems { - return new AddTodoItems(names); - } - - @step('{0} adds #description') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo(...this.addAll(this.items)); // array -> var args conversion - } - - constructor(private items: string[]) { - } - - // used in @step as #description - private description() { // tslint:disable-line:no-unused-variable - return !! this.items.length - ? `todo items called: "${ this.items.join('", "') }"` - : 'no items'; - } - - private addAll(items: string[]): Task[] { - return items.map(item => AddATodoItem.called(item)); - } -} diff --git a/examples/todomvc-model/src/tasks/complete_a_todo_item.ts b/examples/todomvc-model/src/tasks/complete_a_todo_item.ts deleted file mode 100644 index 79b833149a5..00000000000 --- a/examples/todomvc-model/src/tasks/complete_a_todo_item.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { Click, step, PerformsTasks, Task } from 'serenity-js/lib/screenplay-protractor'; - -import { TodoList } from '../user_interface'; - -export class CompleteATodoItem implements Task { - static called(itemName: string) { - return new CompleteATodoItem(itemName); - } - - @step('{0} marks "#itemName" as completed') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - Click.on( - TodoList.Complete_Item_Checkbox - .of(this.itemName) - .called(`"${ this.itemName }" checkbox`) - ) - ); - } - - constructor(private itemName: string) { - } -} - diff --git a/examples/todomvc-model/src/tasks/filter_items.ts b/examples/todomvc-model/src/tasks/filter_items.ts deleted file mode 100644 index 0229e152cee..00000000000 --- a/examples/todomvc-model/src/tasks/filter_items.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { Click, PerformsTasks, step, Task } from 'serenity-js/lib/screenplay-protractor'; - -import { TodoList } from '../user_interface'; - -export class FilterItems implements Task { - static toShowOnly(taskType: string) { - return new FilterItems(taskType); - } - - @step('{0} filters the list to show #taskType items') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - Click.on(TodoList.Filter.of(this.taskType) - .called(`filter to show ${ this.taskType } items`)) - ); - } - - constructor(private taskType: string) { - } -} diff --git a/examples/todomvc-model/src/tasks/index.ts b/examples/todomvc-model/src/tasks/index.ts deleted file mode 100644 index d2e72ce5366..00000000000 --- a/examples/todomvc-model/src/tasks/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -export { AddATodoItem } from './add_a_todo_item'; -export { AddTodoItems } from './add_todo_items'; -export { CompleteATodoItem } from './complete_a_todo_item'; -export { FilterItems } from './filter_items'; -export { Start } from './start'; diff --git a/examples/todomvc-model/src/tasks/start.ts b/examples/todomvc-model/src/tasks/start.ts deleted file mode 100644 index 5c4fa91b6ef..00000000000 --- a/examples/todomvc-model/src/tasks/start.ts +++ /dev/null @@ -1,31 +0,0 @@ -import { Open, PerformsTasks, ResizeBrowserWindow, step, Task } from 'serenity-js/lib/screenplay-protractor'; - -import { AddTodoItems } from './add_todo_items'; - -export class Start implements Task { - public static withAnEmptyTodoList(): Start { - return new Start(); - } - - public static withATodoListContaining(items: string[]): Start { - return new Start(items); - } - - @step('{0} starts with a todo list containing #todoListDescription') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - Open.browserOn('/examples/angularjs/'), - ResizeBrowserWindow.toMaximum(), - AddTodoItems.called(this.initialItems) - ); - } - - constructor(private initialItems: string[] = []) { - } - - public todoListDescription(): string { - return !! this.initialItems.length - ? `"${ this.initialItems.join('", "') }"` - : 'no items'; - } -} diff --git a/examples/todomvc-model/src/user_interface/index.ts b/examples/todomvc-model/src/user_interface/index.ts deleted file mode 100644 index 84c2ce2b79e..00000000000 --- a/examples/todomvc-model/src/user_interface/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { TodoList } from './todo_list'; diff --git a/examples/todomvc-model/src/user_interface/todo_list.ts b/examples/todomvc-model/src/user_interface/todo_list.ts deleted file mode 100644 index 73ae9f1bb86..00000000000 --- a/examples/todomvc-model/src/user_interface/todo_list.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { by } from 'protractor'; -import { Target } from 'serenity-js/lib/screenplay-protractor'; - -export class TodoList { - static What_Needs_To_Be_Done = Target.the('"What needs to be done?" input box') - .located(by.id('new-todo')); - - static Items = Target.the('items on the list') - .located(by.repeater('todo in todos')); - - static Filter = Target.the('filter') - .located(by.xpath("//*[@id='filters']//a[.='{0}']")); - - static Complete_Item_Checkbox = Target.the('checkbox for task: {0}') - .located(by.xpath('//*[@class="view" and contains(.,"{0}")]//input[@type="checkbox"]')); -} diff --git a/examples/todomvc-model/tsconfig.json b/examples/todomvc-model/tsconfig.json deleted file mode 100644 index 2b37bc3d571..00000000000 --- a/examples/todomvc-model/tsconfig.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true, - "outDir": "./lib" - }, - - "include": [ - "src/**/*.ts" - ], - - "exclude": [ - "node_modules" - ] -} \ No newline at end of file diff --git a/examples/todomvc-protractor-cucumber-pageobjects/.gitignore b/examples/todomvc-protractor-cucumber-pageobjects/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/examples/todomvc-protractor-cucumber-pageobjects/features/find_things_to_do/filter_the_list.feature b/examples/todomvc-protractor-cucumber-pageobjects/features/find_things_to_do/filter_the_list.feature deleted file mode 100644 index bc77468110c..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/features/find_things_to_do/filter_the_list.feature +++ /dev/null @@ -1,25 +0,0 @@ -Feature: Filter the list to find items of interest - - In order to focus on things that matter - James would like to filter his todo list 
 - to only show items of interest - - Scenario Outline: Viewing items only - - Given that I have a todo list containing Write some code, Walk the dog - And I complete Write some code - When I filter my list to show only tasks - Then my todo list should contain - - Examples: - | applied filter | expected result | - | Active | Walk the dog | - | Completed | Write some code | - - Scenario: Removing the filters to view all the items - - Given that I have a todo list containing Write some code, Walk the dog - And I complete Write some code - When I filter my list to show only Active tasks - And I filter my list to show All tasks - Then my todo list should contain Write some code, Walk the dog diff --git a/examples/todomvc-protractor-cucumber-pageobjects/features/manage_the_todo_list/add_new_items.feature b/examples/todomvc-protractor-cucumber-pageobjects/features/manage_the_todo_list/add_new_items.feature deleted file mode 100644 index 0536a5f48d1..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/features/manage_the_todo_list/add_new_items.feature +++ /dev/null @@ -1,17 +0,0 @@ -Feature: Add new items to the todo list - - In order to avoid having to remember things that need doing - As a forgetful person - I want to be able to record what I need to do in a place where I won't forget about them - - @issues:JIRA-2,JIRA-3 - Scenario: Adding an item to an empty list - Given that I have an empty todo list - When I add Buy some milk to my list - Then Buy some milk should be recorded in my list - - @issue:JIRA-4 - Scenario: Adding an item to a list with other items - Given that I have a todo list containing Buy some cookies, Walk the dog - When I add Buy some cereal to my list - Then my todo list should contain Buy some cookies, Walk the dog, Buy some cereal diff --git a/examples/todomvc-protractor-cucumber-pageobjects/features/manage_the_todo_list/complete_items.feature b/examples/todomvc-protractor-cucumber-pageobjects/features/manage_the_todo_list/complete_items.feature deleted file mode 100644 index 3b8a9991ffe..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/features/manage_the_todo_list/complete_items.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Complete items - - In order to feel a sense of accomplishment - As an active doer - I want to be able to mark the items I've completed - - Scenario: Completing an item - Given that I have a todo list containing Write an article - When I complete Write an article - Then Write an article should be marked as completed diff --git a/examples/todomvc-protractor-cucumber-pageobjects/features/step_definitions/todo_user.steps.js b/examples/todomvc-protractor-cucumber-pageobjects/features/step_definitions/todo_user.steps.js deleted file mode 100644 index 5068f68af7a..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/features/step_definitions/todo_user.steps.js +++ /dev/null @@ -1,41 +0,0 @@ -const - todoListPage = require('../../src/todolist.page'), - listOf = require('../../src/text').listOf, - expect = require('../../src/expect').expect; - -module.exports = function todoUserSteps() { - - this.setDefaultTimeout(60 * 1000); - - this.Given(/^.*that I have an empty todo list$/, () => { - todoListPage.startWithAnEmptyTodoList(); - }); - - this.Given(/^.*that I have a todo list containing (.*)$/, (items) => { - todoListPage.startWithATodoListContaining(listOf(items)); - }); - - this.When(/^I add (.*?) to my list$/, (item) => { - todoListPage.addATodoItemCalled(item); - }); - - this.When(/^I complete (.*)$/, (item) => { - todoListPage.completeATodoItemCalled(item); - }); - - this.When(/^I filter my list to show (?:only )?(.*) tasks$/, (taskType) => { - todoListPage.filterItemsToShowOnly(taskType); - }); - - this.Then(/^(.*?) should be recorded in my list$/, (item) => { - expect(todoListPage.itemsDisplayed()).to.eventually.contain(item); - }); - - this.Then(/^(.*?) should be marked as (.*?)$/, (item, status) => { - expect(todoListPage.statusOf(item)).to.eventually.equal(status); - }); - - this.Then(/^.* todo list should contain (.*?)$/, (items) => { - expect(todoListPage.itemsDisplayed()).to.eventually.eql(listOf(items)); - }); -}; diff --git a/examples/todomvc-protractor-cucumber-pageobjects/package.json b/examples/todomvc-protractor-cucumber-pageobjects/package.json deleted file mode 100644 index 9ef83469309..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/package.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "name": "serenity-protractor-cucumber-pageobjects", - "version": "1.0.0", - "description": "Serenity.js with classic Protractor and Cucumber setup", - "main": "index.js", - "scripts": { - "clean": "rimraf target", - "pretest": "serenity update", - "pree2e": "npm run webdriver:update -- --standalone --versions.standalone=2.53.1 --versions.chrome=2.29", - "e2e": "protractor ./protractor.conf.js", - "e2e-single": "protractor ./protractor.conf.js --cucumberOpts.name", - "report": "serenity run", - "test": "failsafe e2e report", - "webdriver-manager": "webdriver-manager", - "webdriver:update": "npm run webdriver-manager update" - }, - "author": "Jan Molak ", - "license": "Apache-2.0", - "dependencies": {}, - "devDependencies": { - "chai": "3.5.0", - "chai-as-promised": "5.3.0", - "chai-smoothie": "^0.2.0", - "cucumber": "1.3.2", - "npm-failsafe": "^0.4.1", - "protractor": "5.1.1", - "protractor-cucumber-framework": "0.6.0", - "rimraf": "2.5.4", - "serenity-cli": "^0.1.4", - "serenity-js": "file:../../" - } -} diff --git a/examples/todomvc-protractor-cucumber-pageobjects/protractor.conf.js b/examples/todomvc-protractor-cucumber-pageobjects/protractor.conf.js deleted file mode 100644 index 956d129cec8..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/protractor.conf.js +++ /dev/null @@ -1,41 +0,0 @@ -exports.config = { - - framework: 'custom', - - // To get the awesome Serenity BDD reports, replace this entry: - // frameworkPath: require.resolve('protractor-cucumber-framework'), - - // with this one: - frameworkPath: require.resolve('serenity-js'), - - // Yes, that's all you need :-) - - // ----------------------------------------------------------------------------------------------------------------- - - baseUrl: 'http://todomvc.com', - - allScriptsTimeout: 110000, - - specs: [ 'features/**/*.feature' ], - cucumberOpts: { - require: [ 'features/**/*.js' ], - format: 'pretty' - }, - - capabilities: { - browserName: 'chrome', - chromeOptions: { - args: [ - // 'incognito', - // 'disable-extensions', - // 'show-fps-counter=true' - ] - }, - - // execute tests using 2 browsers running in parallel - shardTestFiles: true, - maxInstances: 2 - }, - - restartBrowserBetweenTests: true -}; diff --git a/examples/todomvc-protractor-cucumber-pageobjects/rebuild-serenity-js b/examples/todomvc-protractor-cucumber-pageobjects/rebuild-serenity-js deleted file mode 100755 index e63f8deb257..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/rebuild-serenity-js +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -rm -rf node_modules/serenity-js -rm -rf ~/.npm/serenity-js - -pushd ../../packages/serenity-js -npm run rebuild -popd - -npm install diff --git a/examples/todomvc-protractor-cucumber-pageobjects/src/expect.js b/examples/todomvc-protractor-cucumber-pageobjects/src/expect.js deleted file mode 100644 index 8051563c1c6..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/src/expect.js +++ /dev/null @@ -1,7 +0,0 @@ -'use strict'; - -const chai = require('chai'); - -chai.use(require('chai-as-promised')); - -module.exports.expect = chai.expect; diff --git a/examples/todomvc-protractor-cucumber-pageobjects/src/text.js b/examples/todomvc-protractor-cucumber-pageobjects/src/text.js deleted file mode 100644 index fcfefea8c83..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/src/text.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports.listOf = function(commaSeparatedValues ) { - return commaSeparatedValues.split(',').map(i => i.trim()); -} diff --git a/examples/todomvc-protractor-cucumber-pageobjects/src/todolist.page.js b/examples/todomvc-protractor-cucumber-pageobjects/src/todolist.page.js deleted file mode 100644 index bd24d3848bf..00000000000 --- a/examples/todomvc-protractor-cucumber-pageobjects/src/todolist.page.js +++ /dev/null @@ -1,90 +0,0 @@ -const format = require('util').format; - -const TodoListPage = function() { - - const po = this; - - // One responsibility of a traditional Page Object - // is to define the structure of a page the test will interact with. - - po.What_Needs_To_Be_Done = by.id('new-todo') - - po.Items = by.repeater('todo in todos'); - - po.Filters = by.id('filters'); - - po.Complete_Item_Checkbox = function (name) { - - // Even though the methods on a Page Object should be kept simple, - // you'll often find that they generate dynamic locators, - // manipulate data, try to figure out where a given page object sits in a page object hierarchy - // and do other things that cause Page Objects to grow and quickly become difficult to maintain. - - // This method generates a dynamic locator: - - return by.xpath(format('//*[@class="view" and contains(.,"%s")]//input[@type="checkbox"]', name)); - }; - - // ----------------------------------------------------------------------------------------------------------------- - - // The second responsibility of a traditional Page Object - // is to define the interactions a user can have with a specific page the Page Object models. - - po.startWithAnEmptyTodoList = function () { - po.startWithATodoListContaining([]); - }; - - po.startWithATodoListContaining = function (items) { - browser.get('/examples/angularjs/'); - browser.manage().window().maximize() - - items.forEach(function(item) { - po.addATodoItemCalled(item) - }); - }; - - // Please note that every locator defined in the first section is typically resolved using a single, - // global `browser` object. This makes it difficult to write tests - // that require more than one browser, for example when you're testing a chat system - // or a multi-player video game. - - po.addATodoItemCalled = function (name) { - browser.element(po.What_Needs_To_Be_Done).sendKeys(name); - browser.element(po.What_Needs_To_Be_Done).sendKeys(protractor.Key.ENTER); - }; - - po.addTodoItemsCalled = function (names) { - names.forEach(function(name) { - po.addATodoItemCalled(name) - }); - }; - - po.completeATodoItemCalled = function (name) { - browser.element(po.Complete_Item_Checkbox(name)).click() - }; - - po.filterItemsToShowOnly = function (taskType) { - browser.element(po.Filters).element(by.linkText(taskType)).click(); - }; - - // ----------------------------------------------------------------------------------------------------------------- - - // The third responsibility of a Page Object is to define the questions a user can ask about the contents - // of the page. - - po.itemsDisplayed = function () { - return browser.element.all(po.Items).map(function (item) { - return item.getText(); - }); - }; - - po.statusOf = function (item) { - return browser.element(po.Complete_Item_Checkbox(item)) - .isSelected() - .then(function(selected) { // Even though Protractor's API seems synchronous, - return selected ? 'completed' : 'active'; // you'll find that you have to work with promises anyway. - }); - }; -}; - -module.exports = new TodoListPage(); \ No newline at end of file diff --git a/examples/todomvc-protractor-cucumber/.gitignore b/examples/todomvc-protractor-cucumber/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/examples/todomvc-protractor-cucumber/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/examples/todomvc-protractor-cucumber/features/find_things_to_do/filter_the_list.feature b/examples/todomvc-protractor-cucumber/features/find_things_to_do/filter_the_list.feature deleted file mode 100644 index cee1a50b569..00000000000 --- a/examples/todomvc-protractor-cucumber/features/find_things_to_do/filter_the_list.feature +++ /dev/null @@ -1,25 +0,0 @@ -Feature: Filter the list to find items of interest - - In order to focus on things that matter - James would like to filter his todo list - to only show items of interest - - Scenario Outline: Viewing items only - - Given that James has a todo list containing Write some code, Walk the dog - And he completes Write some code - When he filters his list to show only tasks - Then his todo list should contain - - Examples: - | applied filter | expected result | - | Active | Walk the dog | - | Completed | Write some code | - - Scenario: Removing the filters to view all the items - - Given that James has a todo list containing Write some code, Walk the dog - And he completes Write some code - When he filters his list to show only Active tasks - And he filters his list to show All tasks - Then his todo list should contain Write some code, Walk the dog diff --git a/examples/todomvc-protractor-cucumber/features/manage_the_todo_list/add_new_items.feature b/examples/todomvc-protractor-cucumber/features/manage_the_todo_list/add_new_items.feature deleted file mode 100644 index ef460ed2719..00000000000 --- a/examples/todomvc-protractor-cucumber/features/manage_the_todo_list/add_new_items.feature +++ /dev/null @@ -1,17 +0,0 @@ -Feature: Add new items to the todo list - - In order to avoid having to remember things that need doing - As a forgetful person - I want to be able to record what I need to do in a place where I won't forget about them - - @issues:JIRA-2,JIRA-3 - Scenario: Adding an item to an empty list - Given that James has an empty todo list - When he adds Buy some milk to his list - Then Buy some milk should be recorded in his list - - @issue:JIRA-4 - Scenario: Adding an item to a list with other items - Given that James has a todo list containing Buy some cookies, Walk the dog - When he adds Buy some cereal to his list - Then his todo list should contain Buy some cookies, Walk the dog, Buy some cereal diff --git a/examples/todomvc-protractor-cucumber/features/manage_the_todo_list/complete_items.feature b/examples/todomvc-protractor-cucumber/features/manage_the_todo_list/complete_items.feature deleted file mode 100644 index c5e713d446a..00000000000 --- a/examples/todomvc-protractor-cucumber/features/manage_the_todo_list/complete_items.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Complete items - - In order to feel a sense of accomplishment - As an active doer - I want to be able to mark the items I've completed - - Scenario: Completing an item - Given that James has a todo list containing Write an article - When he completes Write an article - Then Write an article should be marked as completed \ No newline at end of file diff --git a/examples/todomvc-protractor-cucumber/features/step_definitions/todo_user.steps.ts b/examples/todomvc-protractor-cucumber/features/step_definitions/todo_user.steps.ts deleted file mode 100644 index ff02fb40000..00000000000 --- a/examples/todomvc-protractor-cucumber/features/step_definitions/todo_user.steps.ts +++ /dev/null @@ -1,68 +0,0 @@ -import { - AddATodoItem, - CompleteATodoItem, - FilterItems, - ItemStatus, - Start, - TodoListItems, -} from 'todomvc-model'; - -import { See } from 'serenity-js/lib/screenplay-protractor'; - -import { expect } from '../../src/expect'; -import { listOf } from '../../src/text'; - -export = function todoUserSteps() { - - this.Given(/^.*that (.*) has an empty todo list$/, function(name: string) { - return this.stage.theActorCalled(name).attemptsTo( - Start.withAnEmptyTodoList()); - }); - - this.Given(/^.*that (.*) has a todo list containing (.*)$/, function(name: string, items: string) { - return this.stage.theActorCalled(name).attemptsTo( - Start.withATodoListContaining(listOf(items)), - ); - }); - - this.When(/^s?he adds (.*?) to (?:his|her) list$/, function(itemName: string) { - - return this.stage.theActorInTheSpotlight().attemptsTo( - AddATodoItem.called(itemName), - ); - }); - - this.When(/^s?he completes (.*)$/, function(itemName: string) { - - return this.stage.theActorInTheSpotlight().attemptsTo( - CompleteATodoItem.called(itemName), - ); - }); - - this.When(/^s?he filters (?:her|his) list to show (?:only )?(.*) tasks$/, function(taskType: string) { - return this.stage.theActorInTheSpotlight().attemptsTo( - FilterItems.toShowOnly(taskType), - ); - }); - - this.Then(/^(.*?) should be recorded in his list$/, function(item: string) { - - return this.stage.theActorInTheSpotlight().attemptsTo( - See.if(TodoListItems.Displayed, actual => expect(actual).to.eventually.contain(item)), - ); - }); - - this.Then(/^(.*?) should be marked as (.*?)$/, function(item: string, status: string) { - - return this.stage.theActorInTheSpotlight().attemptsTo( - See.if(ItemStatus.of(item), actual => expect(actual).to.eventually.eql(status)), - ); - }); - - this.Then(/^.* todo list should contain (.*?)$/, function(items: string) { - - return this.stage.theActorInTheSpotlight().attemptsTo( - See.if(TodoListItems.Displayed, actual => expect(actual).to.eventually.eql(listOf(items))), - ); - }); -}; diff --git a/examples/todomvc-protractor-cucumber/features/support/world.ts b/examples/todomvc-protractor-cucumber/features/support/world.ts deleted file mode 100644 index d12264c836e..00000000000 --- a/examples/todomvc-protractor-cucumber/features/support/world.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { serenity } from 'serenity-js'; - -import { Actors } from 'todomvc-model'; - -export = function() { - - this.setDefaultTimeout(60 * 1000); - - this.World = function() { - this.stage = serenity.callToStageFor(new Actors()); - }; -}; diff --git a/examples/todomvc-protractor-cucumber/package.json b/examples/todomvc-protractor-cucumber/package.json deleted file mode 100644 index eb78bdf6a2f..00000000000 --- a/examples/todomvc-protractor-cucumber/package.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "name": "serenity-protractor-cucumber", - "version": "1.0.0", - "description": "Serenity.js with Protractor and Cucumber", - "main": "index.js", - "scripts": { - "clean": "rimraf target", - "lint": "tslint --config ../../tslint.json --project ./tsconfig.json --format stylish", - "pretest": "serenity update", - "pree2e": "npm run lint && npm run webdriver:update -- --standalone --versions.standalone=3.0.1", - "e2e": "protractor ./protractor.conf.js", - "e2e-single": "protractor ./protractor.conf.js --cucumberOpts.name", - "report": "serenity run", - "test": "failsafe e2e report", - "webdriver:update": "webdriver-manager update", - "proxy": "webdriver-manager start", - "e2e-demo": "protractor ./protractor.conf.js --highlightDelay 2000 --seleniumAddress http://localhost:4444/wd/hub" - }, - "author": "Jan Molak ", - "license": "Apache-2.0", - "dependencies": {}, - "devDependencies": { - "@types/chai": "3.4.34", - "@types/chai-as-promised": "0.0.29", - "@types/node": "6.0.53", - "chai": "3.5.0", - "chai-as-promised": "5.3.0", - "chai-smoothie": "^0.2.0", - "cucumber": "1.3.2", - "npm-failsafe": "^0.4.1", - "protractor": "5.1.1", - "rimraf": "2.5.4", - "serenity-cli": "0.x", - "serenity-js": "file:../../packages/serenity-js", - "todomvc-model": "file:../todomvc-model", - "ts-node": "1.7.2", - "tslint": "4.3.1", - "typescript": "2.1.4" - } -} diff --git a/examples/todomvc-protractor-cucumber/protractor.conf.js b/examples/todomvc-protractor-cucumber/protractor.conf.js deleted file mode 100644 index 3e11c0d2867..00000000000 --- a/examples/todomvc-protractor-cucumber/protractor.conf.js +++ /dev/null @@ -1,56 +0,0 @@ -const crew = require('serenity-js/lib/stage_crew'); - -var _ = require('lodash'), - path = require('path'), - protractor = require.resolve('protractor'), - node_modules = protractor.substring(0, protractor.lastIndexOf('node_modules') + 12); - -exports.config = { - - seleniumServerJar: path.resolve(node_modules, 'protractor/node_modules/webdriver-manager/selenium/selenium-server-standalone-3.0.1.jar'), - - baseUrl: 'http://todomvc.com', - - allScriptsTimeout: 110000, - - framework: 'custom', - frameworkPath: require.resolve('serenity-js'), - serenity: { - dialect: 'cucumber', - crew: [ - crew.serenityBDDReporter() - // , - // crew.consoleReporter(), - // crew.Photographer.who(_ => _ - // .takesPhotosOf(_.Failures) - // .takesPhotosWhen(_.Activity_Finishes) - // ) - ] - }, - - specs: [ 'features/**/*.feature' ], - cucumberOpts: { - require: [ 'features/**/*.ts' ], - format: 'pretty', - compiler: 'ts:ts-node/register' - }, - - capabilities: { - browserName: 'chrome', - chromeOptions: { - args: [ - '--disable-infobars' - // '--incognito', - // '--disable-extensions', - // '--show-fps-counter=true' - ] - } - // , - - // execute tests using 2 browsers running in parallel - // shardTestFiles: true, - // maxInstances: 2 - }, - - restartBrowserBetweenTests: false -}; diff --git a/examples/todomvc-protractor-cucumber/rebuild-serenity-js b/examples/todomvc-protractor-cucumber/rebuild-serenity-js deleted file mode 100755 index e63f8deb257..00000000000 --- a/examples/todomvc-protractor-cucumber/rebuild-serenity-js +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -rm -rf node_modules/serenity-js -rm -rf ~/.npm/serenity-js - -pushd ../../packages/serenity-js -npm run rebuild -popd - -npm install diff --git a/examples/todomvc-protractor-cucumber/rebuild-todomvc-model b/examples/todomvc-protractor-cucumber/rebuild-todomvc-model deleted file mode 100755 index dd188e8ef3c..00000000000 --- a/examples/todomvc-protractor-cucumber/rebuild-todomvc-model +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env bash - -rm -rf node_modules/todomvc-model -rm -rf ~/.npm/todomvc-model - -pushd ../todomvc-model -npm install -npm run rebuild -popd - -npm install diff --git a/examples/todomvc-protractor-cucumber/src/expect.ts b/examples/todomvc-protractor-cucumber/src/expect.ts deleted file mode 100644 index 099195f7af6..00000000000 --- a/examples/todomvc-protractor-cucumber/src/expect.ts +++ /dev/null @@ -1,6 +0,0 @@ -import chai = require('chai'); -import chaiAsPromised = require('chai-as-promised'); - -chai.use(chaiAsPromised); - -export const expect = chai.expect; diff --git a/examples/todomvc-protractor-cucumber/src/text.ts b/examples/todomvc-protractor-cucumber/src/text.ts deleted file mode 100644 index e218885ab1a..00000000000 --- a/examples/todomvc-protractor-cucumber/src/text.ts +++ /dev/null @@ -1,3 +0,0 @@ -export function listOf(commaSeparatedValues: string): string[] { - return commaSeparatedValues.split(',').map(i => i.trim()); -} diff --git a/examples/todomvc-protractor-cucumber/tsconfig.json b/examples/todomvc-protractor-cucumber/tsconfig.json deleted file mode 100644 index f3070a3fb6b..00000000000 --- a/examples/todomvc-protractor-cucumber/tsconfig.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true - }, - - "exclude": [ - "node_modules" - ] -} diff --git a/examples/todomvc-protractor-mocha/.gitignore b/examples/todomvc-protractor-mocha/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/examples/todomvc-protractor-mocha/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/examples/todomvc-protractor-mocha/package.json b/examples/todomvc-protractor-mocha/package.json deleted file mode 100644 index 8dcec9ce9f8..00000000000 --- a/examples/todomvc-protractor-mocha/package.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "name": "serenity-protractor-mocha", - "version": "1.0.0", - "description": "Serenity.js with Protractor and Mocha", - "main": "index.js", - "scripts": { - "clean": "rimraf target", - "lint": "tslint --config ../../tslint.json --project ./tsconfig.json --format stylish", - "pretest": "serenity update", - "pree2e": "npm run lint && npm run webdriver:update -- --standalone --versions.standalone=2.53.1 --versions.chrome=2.29", - "e2e": "protractor ./protractor.conf.js", - "e2e-single": "protractor ./protractor.conf.js --mochaOpts.grep", - "report": "serenity run", - "test": "failsafe e2e report", - "webdriver-manager": "webdriver-manager", - "webdriver:update": "npm run webdriver-manager update" - }, - "author": "Jan Molak ", - "license": "Apache-2.0", - "dependencies": { - - }, - "devDependencies": { - "@types/chai": "3.4.34", - "@types/chai-as-promised": "0.0.29", - "@types/mocha": "2.2.34", - "@types/node": "6.0.53", - "chai": "3.5.0", - "chai-as-promised": "5.3.0", - "chai-smoothie": "^0.2.0", - "mocha": "3.2.0", - "npm-failsafe": "^0.4.1", - "protractor": "5.1.1", - "rimraf": "2.5.4", - "serenity-cli": "^0.1.4", - "serenity-js": "file:../../", - "todomvc-model": "file:../todomvc-model", - "ts-node": "1.7.2", - "tslint": "4.3.1", - "typescript": "2.1.4" - } -} diff --git a/examples/todomvc-protractor-mocha/protractor.conf.js b/examples/todomvc-protractor-mocha/protractor.conf.js deleted file mode 100644 index 7b8af69ffee..00000000000 --- a/examples/todomvc-protractor-mocha/protractor.conf.js +++ /dev/null @@ -1,47 +0,0 @@ -require('ts-node/register'); - -const crew = require('serenity-js/lib/stage_crew'); - -exports.config = { - - baseUrl: 'http://todomvc.com', - - allScriptsTimeout: 110000, - - framework: 'custom', - frameworkPath: require.resolve('serenity-js'), - serenity: { - dialect: 'mocha', - crew: [ - crew.serenityBDDReporter(), - crew.consoleReporter(), - crew.Photographer.who(_ => _ - .takesPhotosOf(_.Tasks_and_Interactions) - .takesPhotosWhen(_.Activity_Finishes) - ) - ] - }, - - specs: [ 'spec/**/*.spec.ts' ], - - capabilities: { - browserName: 'chrome', - chromeOptions: { - args: [ - // 'incognito', - // 'disable-extensions', - // 'show-fps-counter=true' - ] - }, - - // execute tests using 2 browsers running in parallel - shardTestFiles: true, - maxInstances: 2 - }, - - restartBrowserBetweenTests: true, - - onPrepare: function() { - browser.ignoreSynchronization = false; - } -}; diff --git a/examples/todomvc-protractor-mocha/rebuild-serenity-js b/examples/todomvc-protractor-mocha/rebuild-serenity-js deleted file mode 100755 index e63f8deb257..00000000000 --- a/examples/todomvc-protractor-mocha/rebuild-serenity-js +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -rm -rf node_modules/serenity-js -rm -rf ~/.npm/serenity-js - -pushd ../../packages/serenity-js -npm run rebuild -popd - -npm install diff --git a/examples/todomvc-protractor-mocha/rebuild-todomvc-model b/examples/todomvc-protractor-mocha/rebuild-todomvc-model deleted file mode 100755 index dd188e8ef3c..00000000000 --- a/examples/todomvc-protractor-mocha/rebuild-todomvc-model +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env bash - -rm -rf node_modules/todomvc-model -rm -rf ~/.npm/todomvc-model - -pushd ../todomvc-model -npm install -npm run rebuild -popd - -npm install diff --git a/examples/todomvc-protractor-mocha/spec/find_things_to_do/filter_the_list.spec.ts b/examples/todomvc-protractor-mocha/spec/find_things_to_do/filter_the_list.spec.ts deleted file mode 100644 index 5ac7c602e58..00000000000 --- a/examples/todomvc-protractor-mocha/spec/find_things_to_do/filter_the_list.spec.ts +++ /dev/null @@ -1,41 +0,0 @@ -import { serenity } from 'serenity-js'; -import { Actors, CompleteATodoItem, FilterItems, Start } from 'todomvc-model'; -import { Ensure } from '../../src/tasks/ensure'; - -describe('Finding things to do', function() { - this.timeout(60 * 1000); - - const stage = serenity.callToStageFor(new Actors()); - - describe('James can', () => { - - describe('apply filters so that the list', () => { - beforeEach(() => stage.theActorCalled('James').attemptsTo( - Start.withATodoListContaining([ 'Write some code', 'Walk the dog' ]), - )); - - it('shows active items only', () => stage.theActorInTheSpotlight().attemptsTo( - CompleteATodoItem.called('Write some code'), - FilterItems.toShowOnly('Active'), - Ensure.theListOnlyContains('Walk the dog'), - )); - - it('shows completed items only', () => stage.theActorInTheSpotlight().attemptsTo( - CompleteATodoItem.called('Write some code'), - FilterItems.toShowOnly('Completed'), - Ensure.theListOnlyContains('Write some code'), - )); - }); - - describe('remove filters so that the list', () => { - - it('shows all the items', () => stage.theActorCalled('James').attemptsTo( - Start.withATodoListContaining([ 'Write some code', 'Walk the dog' ]), - CompleteATodoItem.called('Write some code'), - FilterItems.toShowOnly('Active'), - FilterItems.toShowOnly('All'), - Ensure.theListOnlyContains('Write some code', 'Walk the dog'), - )); - }); - }); -}); diff --git a/examples/todomvc-protractor-mocha/spec/manage_the_todo_list/add_new_items.spec.ts b/examples/todomvc-protractor-mocha/spec/manage_the_todo_list/add_new_items.spec.ts deleted file mode 100644 index e0391b6d037..00000000000 --- a/examples/todomvc-protractor-mocha/spec/manage_the_todo_list/add_new_items.spec.ts +++ /dev/null @@ -1,28 +0,0 @@ -import { serenity } from 'serenity-js'; -import { Actors, AddATodoItem, Start } from 'todomvc-model'; -import { Ensure } from '../../src/tasks/ensure'; - -describe('Managing a Todo List', function() { - this.timeout(60 * 1000); - - const stage = serenity.callToStageFor(new Actors()); - - describe('James can add an item when his list', () => { - - it('is empty', () => stage.theActorCalled('James').attemptsTo( - Start.withAnEmptyTodoList(), - AddATodoItem.called('Buy some milk'), - Ensure.theListIncludes('Buy some milk'), - )); - - it('already contains other items', () => stage.theActorCalled('James').attemptsTo( - Start.withATodoListContaining([ 'Buy some cookies', 'Walk the dog' ]), - AddATodoItem.called('Buy some milk'), - Ensure.theListOnlyContains( - 'Buy some cookies', - 'Walk the dog', - 'Buy some milk', - ), - )); - }); -}); diff --git a/examples/todomvc-protractor-mocha/spec/manage_the_todo_list/complete_items.spec.ts b/examples/todomvc-protractor-mocha/spec/manage_the_todo_list/complete_items.spec.ts deleted file mode 100644 index 6d72c0d6ea0..00000000000 --- a/examples/todomvc-protractor-mocha/spec/manage_the_todo_list/complete_items.spec.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { serenity } from 'serenity-js'; -import { Actors, CompleteATodoItem, Start } from 'todomvc-model'; -import { Ensure } from '../../src/tasks/ensure'; - -describe('Managing a Todo List', function() { - this.timeout(60 * 1000); - - const stage = serenity.callToStageFor(new Actors()); - - describe('James', () => { - - it('can mark the items he\'s done with as completed', () => stage.theActorCalled('James').attemptsTo( - Start.withATodoListContaining([ 'Walk the dog' ]), - CompleteATodoItem.called('Walk the dog'), - Ensure.itemIsMarkedAsCompleted('Walk the dog'), - )); - }); -}); diff --git a/examples/todomvc-protractor-mocha/src/tasks/ensure.ts b/examples/todomvc-protractor-mocha/src/tasks/ensure.ts deleted file mode 100644 index 660dcd910ec..00000000000 --- a/examples/todomvc-protractor-mocha/src/tasks/ensure.ts +++ /dev/null @@ -1,59 +0,0 @@ -import { PerformsTasks, See, step, Task } from 'serenity-js/lib/screenplay'; -import { ItemStatus, TodoListItems } from 'todomvc-model'; - -import chai = require('chai'); - -chai.use(require('chai-as-promised')); // tslint:disable-line:no-var-requires - -export class Ensure { - static itemIsMarkedAsCompleted = (item: string): Task => new ItemMarkedAsCompleted(item); - - static theListIncludes = (item: string): Task => new Includes(item); - - static theListOnlyContains = (...items: string[]): Task => new Equals(items); -} - -const isMarkedAs = expected => actual => chai.expect(actual).to.eventually.eql(expected); - -class ItemMarkedAsCompleted implements Task { - - @step('{0} ensures that \'#item\' is marked as complete') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - See.if(ItemStatus.of(this.item), isMarkedAs('completed')), - ); - } - - constructor(private item: string) { - } -} - -const equals = expected => actual => chai.expect(actual).to.eventually.eql(expected); - -class Equals implements Task { - - @step('{0} ensures that the list contains only #expectedItems') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - See.if(TodoListItems.Displayed, equals(this.expectedItems)), - ); - } - - constructor(private expectedItems: string[]) { - } -} - -const includes = expected => actual => chai.expect(actual).to.eventually.include(expected); - -class Includes implements Task { - - @step('{0} ensures that the list includes #expectedItem') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( - See.if(TodoListItems.Displayed, includes(this.expectedItem)), - ); - } - - constructor(private expectedItem: string) { - } -} diff --git a/examples/todomvc-protractor-mocha/tsconfig.json b/examples/todomvc-protractor-mocha/tsconfig.json deleted file mode 100644 index f3070a3fb6b..00000000000 --- a/examples/todomvc-protractor-mocha/tsconfig.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true - }, - - "exclude": [ - "node_modules" - ] -} diff --git a/package.json b/package.json index d8742a375b4..41e3bb2dce2 100644 --- a/package.json +++ b/package.json @@ -42,8 +42,8 @@ "@types/chai-as-promised": "7.1.0", "@types/mocha": "5.2.1", "@types/node": "6.0.96", - "@types/sinon": "4.3.1", - "@types/sinon-chai": "2.7.31", + "@types/sinon": "5.0.1", + "@types/sinon-chai": "3.2.0", "chai": "4.1.2", "chai-as-promised": "7.1.1", "commitizen": "2.10.0", @@ -71,14 +71,13 @@ "mocha-testdata": "1.2.0", "nyc": "10.1.2", "rimraf": "2.6.2", - "sinon": "5.0.7", - "sinon-chai": "3.0.0", + "sinon": "6.1.3", + "sinon-chai": "3.2.0", "travis-deploy-once": "^5.0.0", - "ts-helper": "0.0.1", - "ts-node": "6.0.4", + "ts-node": "7.0.0", "tslint": "4.4.2", "tslint-microsoft-contrib": "4.0.0", - "typescript": "2.3.4" + "typescript": "2.9.2" }, "repository": { "type": "git", diff --git a/packages/core/package.json b/packages/core/package.json index 0d1ad4e54f8..35b3090c7d0 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -15,7 +15,8 @@ "tdd", "test", "testing", - "serenity" + "serenity", + "screenplay" ], "scripts": { "clean": "rimraf lib", @@ -25,18 +26,16 @@ "verify": "npm run clean && npm run lint && npm test && npm run package" }, "dependencies": { + "error-stack-parser": "2.0.1", "graceful-fs": "4.1.11", - "lodash": "4.17.4", "mkdirp": "0.5.1", - "moment": "2.18.1", - "stacktrace-js": "2.0.0", - "ts-md5": "1.2.0" + "moment": "2.22.1", + "sanitize-filename": "1.6.1", + "tiny-types": "1.10.1" }, "devDependencies": { - "@types/graceful-fs": "2.0.29", - "@types/lodash": "4.14.55", - "@types/mkdirp": "0.3.29", - "@types/stacktrace-js": "0.0.30" + "@types/mkdirp": "0.5.2", + "@types/sanitize-filename": "1.1.28" }, "repository": { "type": "git", @@ -58,7 +57,6 @@ "*.js", "lib", "spec", - "staging", "node_modules" ], "extension": [ @@ -68,6 +66,7 @@ "ts-node/register" ], "reporter": [ + "html", "json", "text-summary" ], diff --git a/packages/core/spec/Recorder.ts b/packages/core/spec/Recorder.ts new file mode 100644 index 00000000000..c5ba65cfea1 --- /dev/null +++ b/packages/core/spec/Recorder.ts @@ -0,0 +1,15 @@ +import { DomainEvent } from '../src/domain'; +import { StageCrewMember, StageManager } from '../src/stage'; + +export class Recorder implements StageCrewMember { + + public readonly events: DomainEvent[] = []; + + assignTo(stageManager: StageManager) { + stageManager.register(this); + } + + notifyOf(event: DomainEvent) { + this.events.push(event); + } +} diff --git a/packages/core/spec/abilities/take_notes.spec.ts b/packages/core/spec/abilities/take_notes.spec.ts deleted file mode 100644 index 38980d827f3..00000000000 --- a/packages/core/spec/abilities/take_notes.spec.ts +++ /dev/null @@ -1,134 +0,0 @@ -import sinon = require('sinon'); -import expect = require('../expect'); -import { Actor, Notepad, Question, TakeNote, TakeNotes, UsesAbilities } from '../../src/screenplay'; -import { CompareNotes } from '../../src/screenplay/interactions/compare_notes'; - -describe('Abilities', () => { - - describe('TakeNotes', () => { - - let notepad: Notepad; - - const include = (expected: string) => (actual: PromiseLike): PromiseLike => expect(actual).to.eventually.include(expected), - includeAllOf = (expected: string[]) => (actual: PromiseLike): PromiseLike => expect(actual).to.eventually.include.members(expected), - equals = (expected: T) => (actual: PromiseLike): PromiseLike => expect(actual).to.eventually.equal(expected); - - beforeEach(() => { - notepad = {}; - }); - - it ('stores notes in a notepad as promises to be resolved', () => { - const displayedVoucher = MyVoucherCode.shownAs('SUMMER2017'); - - const actor = Actor.named('Benjamin').whoCan(TakeNotes.using(notepad)); - - return actor.attemptsTo( - TakeNote.of(displayedVoucher).as('my voucher'), - ). - then(() => notepad['my voucher']). - then(voucher => expect(voucher).to.equal('SUMMER2017')); - }); - - it('stores notes using a topic name derived from the question', () => { - const - displayedVoucher = MyVoucherCode.shownAs('SUMMER2017'), - availableVoucher = AvailableVoucher.of('SUMMER2017'), - - actor = Actor.named('Benjamin').whoCan(TakeNotes.usingAnEmptyNotepad()); - - return actor.attemptsTo( - TakeNote.of(displayedVoucher), - CompareNotes.toSeeIf(availableVoucher, equals, displayedVoucher), - ); - }); - - it ('allows the Actor to remember a thing they\'ve seen', () => { - const - displayedVoucher = MyVoucherCode.shownAs('SUMMER2017'), - availableVoucher = AvailableVoucher.of('SUMMER2017'), - - actor = Actor.named('Benjamin').whoCan(TakeNotes.using(notepad)); - - return actor.attemptsTo( - TakeNote.of(displayedVoucher), - /* perform some other tasks */ - CompareNotes.toSeeIf(availableVoucher, equals, displayedVoucher), - ); - }); - - it ('allows the Actor to remember several things they\'ve seen one after another', () => { - const - displayedVoucher = MyVoucherCode.shownAs('SUMMER2017'), - otherDisplayedVoucher = MyVoucherCode.shownAs('50_OFF'), - availableVouchers = AvailableVouchers.of('SUMMER2017', '50_OFF'), - - actor = Actor.named('Benjamin').whoCan(TakeNotes.using(notepad)); - - return actor.attemptsTo( - TakeNote.of(displayedVoucher).as('my voucher'), - /* some other tasks */ - TakeNote.of(otherDisplayedVoucher).as('my other voucher'), - /* some other tasks */ - CompareNotes.toSeeIf(availableVouchers, include, 'my voucher'), - /* some other tasks */ - CompareNotes.toSeeIf(availableVouchers, include, 'my other voucher'), - ); - }); - - it ('allows the Actor to remember several things they\'ve seen at once', () => { - const - displayedVouchers = MyVoucherCodes.shownAs('SUMMER2017', 'SPRINGCLEANING'), - availableVouchers = AvailableVouchers.of('SUMMER2017', '50_OFF', 'SPRINGCLEANING'), - - actor = Actor.named('Benjamin').whoCan(TakeNotes.using(notepad)); - - return actor.attemptsTo( - TakeNote.of(displayedVouchers).as('my vouchers'), - CompareNotes.toSeeIf(availableVouchers, includeAllOf, 'my vouchers'), - ); - }); - - it ('allows the Actor to complain if you ask them about the thing they have no notes on', () => { - const - availableVouchers = AvailableVouchers.of('SUMMER2017', '5OFF', 'SPRINGCLEANING'), - - actor = Actor.named('Benjamin').whoCan(TakeNotes.using(notepad)); - - return expect(actor.attemptsTo( - CompareNotes.toSeeIf(availableVouchers, include, 'my voucher'), - )).to.be.rejectedWith('I don\'t have any notes on the topic of "my voucher"'); - }); - }); -}); - -class MyVoucherCode implements Question> { - static shownAs = (someValue: string) => new MyVoucherCode(someValue); - answeredBy = (actor: UsesAbilities) => Promise.resolve(this.value); - toString = () => 'My voucher code'; - constructor(private value: string) { - } -} - -class MyVoucherCodes implements Question> { - static shownAs = (...someValues: string[]) => new MyVoucherCodes(someValues); - answeredBy = (actor: UsesAbilities) => Promise.resolve(this.values); - toString = () => 'My voucher codes'; - constructor(private values: string[]) { - } -} - -class AvailableVoucher implements Question> { - static of = (someValue: string) => new AvailableVoucher(someValue); - answeredBy = (actor: UsesAbilities) => Promise.resolve(this.value); - toString = () => 'Available voucher'; - constructor(private value: string) { - } -} - -class AvailableVouchers implements Question> { - static of = (...someValues: string[]) => new AvailableVouchers(someValues); - answeredBy = (actor: UsesAbilities): PromiseLike => Promise.resolve(this.values); - toString = () => 'Available vouchers'; - constructor(private values: string[]) { - } -} diff --git a/packages/core/spec/config.spec.ts b/packages/core/spec/config.spec.ts deleted file mode 100644 index 7bdff639943..00000000000 --- a/packages/core/spec/config.spec.ts +++ /dev/null @@ -1,101 +0,0 @@ -import expect = require('./expect'); -import { Config } from '../src/config'; - -interface Example { - path?: string; - mode?: 'dev' | 'prod'; - extensions?: string[]; -} - -describe('Config', () => { - - it('is a thin wrapper around the underlying object', () => { - const defaults = { path: '/temp' }; - const config = new Config(defaults); - - expect(config.get).to.deep.equal(defaults); - }); - - it('is immutable', () => { - const config = new Config({ path: '/temp' }); - config.get.path = '/sys'; - - expect(config.get).to.deep.equal({ - path: '/temp', - }); - }); - - describe('merging', () => { - - it('merges config objects', () => { - const config = new Config({ path: '/temp' }).mergedWith({ mode: 'dev' }); - - expect(config.get).to.deep.equal({ - path: '/temp', - mode: 'dev', - }); - }); - - it('creates a new Config object when two are merged', () => { - const config = new Config({ path: '/temp' }); - const merged = config.mergedWith({ mode: 'dev' }); - - expect(config.get).to.not.deep.equal(merged.get); - - expect(merged.get).to.deep.equal({ - path: '/temp', - mode: 'dev', - }); - }); - - it('concatenates list of properties', () => { - const config = new Config({ extensions: ['js', 'jsx'] }).mergedWith({ extensions: ['ts', 'tsx'] }); - - expect(config.get).to.deep.equal({ - extensions: [ - 'js', - 'jsx', - 'ts', - 'tsx', - ], - }); - }); - }); - - describe('fallback', () => { - - it('provides defaults', () => { - const config = new Config({ }).withFallback({ items: [] }); - - expect(config.get).to.deep.equal({ - items: [], - }); - }); - - it('creates a new Config object when two are merged', () => { - const config = new Config({ path: '/temp' }); - const merged = config.withFallback({ mode: 'dev' }); - - expect(config.get).to.not.deep.equal(merged.get); - - expect(merged.get).to.deep.equal({ - path: '/temp', - mode: 'dev', - }); - }); - - it('merges values, but overrides lists', () => { - const config = new Config({ extensions: ['js', 'jsx'] }).withFallback({ extensions: ['ts', 'tsx'] }); - - expect(config.get).to.deep.equal({ - extensions: ['js', 'jsx'], - }); - }); - - it('falls back to the defaults if no config is provided', () => { - expect(new Config(undefined).withFallback({items: []}).get).to.deep.equal({ - items: [], - }); - }); - }); -}); diff --git a/packages/core/spec/domain/Tag.spec.ts b/packages/core/spec/domain/Tag.spec.ts new file mode 100644 index 00000000000..ce333fed1e7 --- /dev/null +++ b/packages/core/spec/domain/Tag.spec.ts @@ -0,0 +1,27 @@ +import 'mocha'; + +import { given } from 'mocha-testdata'; +import { expect } from '../expect'; + +import { ArbitraryTag, IssueTag, ManualTag, Tag, Tags } from '../../src/domain'; + +describe('Tag', () => { + + given( + [ '@manual', [ new ManualTag() ] ], + [ '@issue:ABC-123', [ new IssueTag('ABC-123') ] ], + [ '@issues:ABC-123', [ new IssueTag('ABC-123') ] ], + [ '@issue:ABC-123,DEF-456', [ new IssueTag('ABC-123'), new IssueTag('DEF-456') ] ], + [ '@issues:ABC-123,DEF-456', [ new IssueTag('ABC-123'), new IssueTag('DEF-456') ] ], + [ '@regression', [ new ArbitraryTag('regression') ] ], + ). + it('can be constructed from a string', (stringTag: string, expectedResults: Tag[]) => { + const results = Tags.from(stringTag); + + expect(results).to.have.lengthOf(expectedResults.length); + + results.forEach((result: Tag, i: number) => { + expect(result).to.equal(expectedResults[i]); + }); + }); +}); diff --git a/packages/core/spec/domain/Timestamp.spec.ts b/packages/core/spec/domain/Timestamp.spec.ts new file mode 100644 index 00000000000..44dd7a867b9 --- /dev/null +++ b/packages/core/spec/domain/Timestamp.spec.ts @@ -0,0 +1,89 @@ +import 'mocha'; + +import { given } from 'mocha-testdata'; +import { expect } from '../expect'; + +import { Duration, Timestamp } from '../../src/domain'; + +describe('Timestamp', () => { + + const + current_time = '01 May 2018 10:00 UTC-2', + current_time_ISO8601 = '2018-05-01T12:00:00.000Z', + now = new Timestamp(new Date(current_time)); + + describe('instantiation', () => { + + it('can be instantiated with an arbitrary Date', () => { + expect(() => new Timestamp(new Date())).to.not.throw; // tslint:disable-line:no-unused-expression + }); + + it('defaults to current time if no argument is provided', () => { + expect(() => new Timestamp()).to.not.throw; // tslint:disable-line:no-unused-expression + }); + + given( + {}, + '01 May 2018 10:00 UTC-2', + 0, + ). + it('complains if given an incorrect value as a constructor argument', (value: any) => { + expect(() => new Timestamp()).to.not.throw('Timestamp should be an instance of Date'); + }); + }); + + describe('serialisation', () => { + + it('is serialised to an ISO-8601-compliant string', () => { + expect(now.toJSON()).to.equal(current_time_ISO8601); + }); + + it('can be deserialised from an ISO-8601-compliant string', () => { + expect(Timestamp.fromJSON(current_time_ISO8601).equals(now)).to.equal(true); + }); + + given( + 0, + '', + null, + undefined, + {}, + [], + ). + it('complains if given an incorrect value to deserialise', (value: any) => { + expect(() => Timestamp.fromJSON(value)).to.throw('Timestamp should be an ISO-8601-compliant date'); + }); + }); + + describe('arithmetic', () => { + + it('allows for calculating a difference between two timestamps', () => { + + const a_bit_later = Timestamp.fromJSON('2018-05-01T12:00:02.752Z'); + + expect(now.diff(a_bit_later).equals(Duration.ofMillis(2752))).to.equal(true); + expect(a_bit_later.diff(now).equals(Duration.ofMillis(2752))).to.equal(true); + }); + + it('allows for computing another timestamp, relative to the original one', () => { + + const + two_minutes = Duration.ofSeconds(120), + four_minutes = Duration.ofSeconds(240); + + expect(now.plus(two_minutes)).to.equal(now.plus(four_minutes).less(two_minutes)); + }); + }); + + describe('conversion', () => { + + it('can be converted to a numeric unix timestamp', () => { + expect(now.toMillisecondTimestamp()).to.equal(Math.floor(now.value.getTime())); + }); + + it('can be created from a numeric unix timestamp', () => { + expect(Timestamp.fromMillisecondTimestamp(Math.floor(now.value.getTime())).toMillisecondTimestamp()) + .to.equal(now.toMillisecondTimestamp()); + }); + }); +}); diff --git a/packages/core/spec/domain/events.spec.ts b/packages/core/spec/domain/events.spec.ts deleted file mode 100644 index 07fb75e51d7..00000000000 --- a/packages/core/spec/domain/events.spec.ts +++ /dev/null @@ -1,34 +0,0 @@ -import expect = require('../expect'); - -import { DomainEvent } from '../../src/domain'; - -describe ('Serenity Domain Events', () => { - - describe ('DomainEvent', () => { - - it ('can be represented as a string to help with trouble shooting', () => { - - const - value = 'value', - timestamp = 1467201010000, - event = new DomainEvent(value, timestamp); - - expect(event.toString()).to.equal(`${ timestamp } | DomainEvent: ${ value }`); - }); - }); - - describe ('Custom Domain Events', () => { - - class CustomEventOccurred extends DomainEvent {}; - - it ('can be represented as a string to help with trouble shooting', () => { - - const - value = 'value', - timestamp = 1467201010000, - event = new CustomEventOccurred(value, timestamp); - - expect(event.toString()).to.equal(`${ timestamp } | CustomEventOccurred: ${ value }`); - }); - }); -}); diff --git a/packages/core/spec/domain/model.spec.ts b/packages/core/spec/domain/model.spec.ts deleted file mode 100644 index c3e4cf5d57b..00000000000 --- a/packages/core/spec/domain/model.spec.ts +++ /dev/null @@ -1,68 +0,0 @@ -import expect = require('../expect'); - -import { RecordedActivity, Tag } from '../../src/domain/model'; - -describe ('Serenity Domain Model', () => { - - describe ('Tag', () => { - - describe ('When parsing cucumber.js tags', () => { - - it ('can have no value', () => { - const tag = Tag.from('@regression'); - - expect(tag.type).to.equal('regression'); - expect(tag.value).to.be.empty; - expect(tag.values).to.be.empty; - }); - - it ('can have a single value', () => { - const tag = Tag.from('@priority: must-have'); - - expect(tag.type).to.equal('priority'); - expect(tag.value).to.equal('must-have'); - expect(tag.values).to.deep.equal([ 'must-have' ]); - }); - - it ('can have multiple values', () => { - const tag = Tag.from('@issues: My-Project-123 , My-Project-789'); - - expect(tag.type).to.equal('issues'); - expect(tag.value).to.equal('My-Project-123, My-Project-789'); - expect(tag.values).to.deep.equal([ 'My-Project-123', 'My-Project-789' ]); - }); - }); - }); - - describe ('RecordedActivity', () => { - - it ('is comparable', () => { - - const - a1 = new RecordedActivity('Pays with a credit card'), - a2 = new RecordedActivity('Pays with a credit card'); - - expect(a1.equals(a2)).to.be.true; - expect(a1).to.deep.equal(a2); - }); - - it ('can be represented as string', () => { - const a = new RecordedActivity('Pays with a credit card'); - - expect(a.toString()).to.equal('Pays with a credit card'); - }); - - it ('knows where it was invoked', () => { - const a = new RecordedActivity('Pays with a credit card', { path: '/some/path/to/script.ts', column: 10, line: 5 }); - - expect(a).recorded.calledAt({ path: '/some/path/to/script.ts', column: 10, line: 5 }); - }); - - it ('can have a custom id', () => { - const some_location = { path: '', column: 0, line: 0 }; - const a = new RecordedActivity('Pays with a credit card', some_location, 'some-custom-id'); - - expect(a.id).to.equal('some-custom-id'); - }); - }); -}); diff --git a/packages/core/spec/domain/model/Duration.spec.ts b/packages/core/spec/domain/model/Duration.spec.ts new file mode 100644 index 00000000000..f2b1f47e229 --- /dev/null +++ b/packages/core/spec/domain/model/Duration.spec.ts @@ -0,0 +1,34 @@ +import 'mocha'; +import { given } from 'mocha-testdata'; + +import { Duration } from '../../../src/domain'; +import { expect } from '../../expect'; + +describe('Duration', () => { + + describe('represents a duration of time that', () => { + + given( + [ Duration.ofMillis(1), 1 ], + [ Duration.ofSeconds(1), 1 * 1000 ], + [ Duration.ofMinutes(1), 60 * 1 * 1000 ], + [ Duration.ofHours(1), 60 * 60 * 1 * 1000 ], + [ Duration.ofDays(1), 24 * 60 * 60 * 1 * 1000 ], + [ Duration.ofYears(1), 365 * 24 * 60 * 60 * 1 * 1000 ], + ). + it('can be easily converted to milliseconds', (duration: Duration, expectedMilliseconds: number) => { + expect(duration.milliseconds).to.equal(expectedMilliseconds); + }); + + given( + [ Duration.ofMillis(100), '100ms' ], + [ Duration.ofMillis(2200), '2s 200ms' ], + [ Duration.ofMillis(132000), '2m 12s' ], + [ Duration.ofMillis(7921000), '2h 12m 1s' ], + [ Duration.ofMillis(190080000), '2d 4h 48m' ], + ). + it('can be presented in a human-friendly format', (duration: Duration, expected: string) => { + expect(duration.toString()).to.equal(expected); + }); + }); +}); diff --git a/packages/core/spec/errors/RuntimeError.spec.ts b/packages/core/spec/errors/RuntimeError.spec.ts new file mode 100644 index 00000000000..a7977fe6e8f --- /dev/null +++ b/packages/core/spec/errors/RuntimeError.spec.ts @@ -0,0 +1,68 @@ +import 'mocha'; + +import { RuntimeError } from '../../src/errors'; +import { expect } from '../expect'; + +describe('RuntimeError', () => { + + describe('subclasses', () => { + + class CustomError extends RuntimeError { + constructor(message: string) { + super(CustomError, message); + } + } + + let error: RuntimeError; + beforeEach(() => { + error = new CustomError('something happened'); + }); + + it('is recognised as an instance of its type', () => { + expect(error).to.be.instanceOf(Error); + expect(error).to.be.instanceOf(RuntimeError); + expect(error).to.be.instanceOf(CustomError); + }); + + it('has a message', () => { + expect(error.message).to.equal('something happened'); + }); + + it('retains the stacktrace', () => { + const frames = error.stack.split('\n'); + + expect(frames[0]).to.equal('CustomError: something happened'); + expect(frames[1]).to.contain(__filename); + }); + }); + + describe('error propagation', () => { + + class ApplicationError extends RuntimeError { + constructor(message: string, cause?: Error) { + super(ApplicationError, message, cause); + } + } + + class IOError extends RuntimeError { + constructor(message: string, cause?: Error) { + super(IOError, message, cause); + } + } + + it('includes the stack trace of the original errors', () => { + + const fsError = new Error('ENOENT: no such file or directory'); + const ioError = new IOError(`Directory not writable`, fsError); + const appError = new ApplicationError('Report could not be saved', ioError); + + const significantFrames = appError.stack.split('\n').filter(frame => ! frame.startsWith(' ')); + + expect(significantFrames).to.deep.equal([ + 'ApplicationError: Report could not be saved', + 'Caused by: IOError: Directory not writable', + 'Caused by: Error: ENOENT: no such file or directory', + ]); + }); + }); +}); diff --git a/packages/core/spec/expect.ts b/packages/core/spec/expect.ts index fcce24e2224..435ef314070 100644 --- a/packages/core/spec/expect.ts +++ b/packages/core/spec/expect.ts @@ -2,61 +2,36 @@ import chai = require('chai'); import sinonChai = require('sinon-chai'); import chaiAsPromised = require('chai-as-promised'); -import { RecordedActivity, SourceLocation } from '../src/domain/model'; - -chai.use(sinonChai); -chai.use(chaiAsPromised); - -declare global { - namespace Chai { // tslint:disable-line:no-namespace - interface Assertion { - recorded: Assertion; - as(name: string): Assertion; - calledAt(expected_location: { path?: string, line?: number, column?: number }): Assertion; - } - } -} +import { TinyType } from 'tiny-types'; chai.use(function(chai, utils) { const Assertion = chai.Assertion; - Assertion.addProperty('recorded', function() { - new Assertion(this._obj).to.be.instanceof(RecordedActivity); - }); - - Assertion.addMethod('as', function(expected_name) { - new Assertion(this._obj.name).to.equal(expected_name); - }); - - Assertion.addMethod('calledAt', function(expected_location: SourceLocation) { - - if (! this._obj.location) { - throw new TypeError(`${ this._obj } does not have a 'location' property`); - } - - if (expected_location.path) { - new Assertion( - this._obj.location.path, - `Expected '${this._obj}' to have been called from ${expected_location.path}, not ${this._obj.location.path}`, - ).contains(expected_location.path); - } - - if (expected_location.line) { - new Assertion( - this._obj.location.line, - `Expected '${this._obj}' to have been called on line ${expected_location.line}, not ${this._obj.location.line}`, - ).equal(expected_location.line); - } - - if (expected_location.column) { - new Assertion( - this._obj.location.column, - `Expected '${this._obj}' to have been called at column ${expected_location.column}, not ${this._obj.location.column}`, - ).equal(expected_location.column); - } - }); + function tinyTypeEqual(_super) { + return function assertTinyTypes(another: TinyType) { + + const obj = this._obj; + if (obj && obj instanceof TinyType) { + this.assert( + obj.equals(another), + `expected #{this} to equal #{exp} but got #{act}`, + `expected #{this} to not equal #{exp} but got #{act}`, + another, + obj, + ); + + } else { + _super.apply(this, arguments); + } + }; + } + + Assertion.overwriteMethod('equal', tinyTypeEqual); + Assertion.overwriteMethod('equals', tinyTypeEqual); + Assertion.overwriteMethod('eq', tinyTypeEqual); }); -const expect = chai.expect; +chai.use(sinonChai); +chai.use(chaiAsPromised); -export = expect; +export const expect = chai.expect; diff --git a/packages/core/spec/io/FileSystem.spec.ts b/packages/core/spec/io/FileSystem.spec.ts new file mode 100644 index 00000000000..4fc1acb629f --- /dev/null +++ b/packages/core/spec/io/FileSystem.spec.ts @@ -0,0 +1,98 @@ +import * as fs from 'fs'; +import * as mockfs from 'mock-fs'; + +import { FileSystem, Path } from '../../src/io'; +import { expect } from '../expect'; + +describe ('FileSystem', () => { + + const + image = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/TQBcNTh/AAAAAXRSTlPM0jRW/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=', + imageBuffer = new Buffer(image, 'base64'), + originalJSON = { name: 'jan' }, + processCWD = new Path('/Users/jan/projects/serenityjs'); + + beforeEach(() => mockfs({ [processCWD.value]: {} })); + afterEach (() => mockfs.restore()); + + describe ('storing JSON files', () => { + + it ('stores a JSON file in a desired location', () => { + const out = new FileSystem(processCWD); + + return out.store(new Path('outlet/some.json'), JSON.stringify(originalJSON)).then(absolutePath => { + + expect(fs.existsSync(absolutePath.value)).to.equal(true); + expect(jsonFrom(absolutePath.value)).to.eql(originalJSON); + }); + }); + + it ('tells the absolute path to a JSON file once it is saved', () => { + const out = new FileSystem(processCWD); + const dest = new Path('outlet/some.json'); + + return out.store(dest, JSON.stringify(originalJSON)). + then(result => expect(result.equals(processCWD.resolve(dest)))); + }); + + it ('complains when provided with an inaccessible path', () => { + mockfs({ '/sys': mockfs.directory({ + mode: 400, + items: { + dir: { /** empty directory */ }, + }, + })}); + + const out = new FileSystem(new Path('/sys')); + + return expect(out.store(new Path('dir/file.json'), JSON.stringify(originalJSON))) + .to.be.eventually.rejectedWith('EACCES, permission denied \'/sys/dir\''); + }); + + it ('complains when provided with an a path to a file that can\'t be overwritten', () => { + mockfs({ '/sys': mockfs.directory({ + mode: 400, + items: { + 'file.json': mockfs.file({ + mode: 400, + content: '', + }), + }, + })}); + + const out = new FileSystem(new Path('/sys')); + + return expect(out.store(new Path('file.json'), JSON.stringify(originalJSON))) + .to.be.eventually.rejectedWith('EACCES, permission denied \'/sys/file.json\''); + }); + }); + + describe ('storing pictures', () => { + + it ('stores a base64-encoded picture at a desired location', () => { + const out = new FileSystem(processCWD); + + return out.store(new Path('outlet/some.png'), imageBuffer).then(absolutePath => { + expect(fs.existsSync(absolutePath.value)).to.equal(true); + expect(pictureAt(absolutePath.value)).to.eql(image); + }); + }); + + it ('tells the absolute path to a JSON file once it is saved', () => { + const out = new FileSystem(processCWD); + const dest = new Path('outlet/some.png'); + + return out.store(dest, imageBuffer).then(absolutePath => { + expect(absolutePath.equals(processCWD.join(dest))).to.equal(true); + }); + }); + }); + + function jsonFrom(file: string) { + return JSON.parse(fs.readFileSync(file).toString('ascii')); + } + + function pictureAt(path: string) { + return new Buffer(fs.readFileSync(path)).toString('base64'); + } +}); diff --git a/packages/core/spec/io/attempt_require.spec.ts b/packages/core/spec/io/attempt_require.spec.ts deleted file mode 100644 index 18c02eb697e..00000000000 --- a/packages/core/spec/io/attempt_require.spec.ts +++ /dev/null @@ -1,24 +0,0 @@ -import expect = require('../expect'); -import { attemptToRequire } from '../../src/io'; - -describe ('io', () => { - - describe ('attemptRequire', () => { - - it ('loads a module if it has been installed', () => { - - const Mocha = attemptToRequire('mocha'); - - expect(Mocha).to.not.be.null; - expect(Mocha).to.be.instanceof(Function); - }); - - it ('loads a module if it has been installed', () => { - - expect(() => attemptToRequire('non-existent')). - to.throw('This feature requires the \'non-existent\' module, which seems to be missing. ' + - 'To install it, run: `npm install non-existent --save[-dev]`'); - }); - }); - -}); diff --git a/packages/core/spec/io/file_system.spec.ts b/packages/core/spec/io/file_system.spec.ts deleted file mode 100644 index b668d289192..00000000000 --- a/packages/core/spec/io/file_system.spec.ts +++ /dev/null @@ -1,107 +0,0 @@ -import * as fs from 'fs'; -import * as mockfs from 'mock-fs'; - -import { FileSystem } from '../../src/io/file_system'; - -import expect = require('../expect'); - -describe ('FileSystem', () => { - - const - image = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/TQBcNTh/AAAAAXRSTlPM0jRW/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=', - imageBuffer = new Buffer(image, 'base64'), - originalJSON = { name: 'jan' }, - processCWD = '/Users/jan/projects/serenityjs'; - - beforeEach(() => mockfs({ '/Users/jan/projects/serenityjs': {} })); - afterEach (() => mockfs.restore()); - - describe ('storing JSON files', () => { - - it ('stores a JSON file at a desired location', () => { - const out = new FileSystem(processCWD); - - return out.store('outlet/some.json', JSON.stringify(originalJSON)).then(absolutePath => { - - expect(fs.existsSync(absolutePath)).to.be.true; - expect(jsonFrom(absolutePath)).to.eql(originalJSON); - }); - }); - - it ('tells the absolute path to a JSON file once it is saved', () => { - const out = new FileSystem(processCWD); - - return expect(out.store('outlet/some.json', JSON.stringify(originalJSON))).to.eventually.equal(`${processCWD}/outlet/some.json`); - }); - - it ('complains when provided with an empty path', () => { - const out = new FileSystem(processCWD); - - return expect(out.store('', JSON.stringify(originalJSON))).to.eventually.be.rejectedWith('Please specify where the file should be saved'); - }); - - it ('complains when provided with an inaccessible path', () => { - mockfs({ '/sys': mockfs.directory({ - mode: 400, - items: { - dir: { /** empty directory */ }, - }, - })}); - - const out = new FileSystem('/sys'); - - return expect(out.store('dir/file.json', JSON.stringify(originalJSON))) - .to.be.eventually.rejectedWith('EACCES, permission denied \'/sys/dir\''); - }); - - it ('complains when provided with an a path to a file that can\'t be overwritten', () => { - mockfs({ '/sys': mockfs.directory({ - mode: 400, - items: { - 'file.json': mockfs.file({ - mode: 400, - content: '', - }), - }, - })}); - - const out = new FileSystem('/sys'); - - return expect(out.store('file.json', JSON.stringify(originalJSON))) - .to.be.eventually.rejectedWith('EACCES, permission denied \'/sys/file.json\''); - }); - }); - - describe ('storing pictures', () => { - - it ('stores a base64-encoded picture at a desired location', () => { - const out = new FileSystem(processCWD); - - return out.store('outlet/some.png', imageBuffer).then(absolutePath => { - expect(fs.existsSync(absolutePath)).to.be.true; - expect(pictureAt(absolutePath)).to.eql(image); - }); - }); - - it ('tells the absolute path to a JSON file once it is saved', () => { - const out = new FileSystem(processCWD); - - return expect(out.store('outlet/some.png', imageBuffer)).to.eventually.equal(`${processCWD}/outlet/some.png`); - }); - - it ('complains when provided with an empty path', () => { - const out = new FileSystem(processCWD); - - return expect(out.store('', imageBuffer)).to.eventually.be.rejectedWith('Please specify where the file should be saved'); - }); - - }); - - function jsonFrom(file: string) { - return JSON.parse(fs.readFileSync(file).toString('ascii')); - } - - function pictureAt(path: string) { - return new Buffer(fs.readFileSync(path)).toString('base64'); - } -}); diff --git a/packages/core/spec/recording.spec.ts b/packages/core/spec/recording.spec.ts deleted file mode 100644 index 658d98ef101..00000000000 --- a/packages/core/spec/recording.spec.ts +++ /dev/null @@ -1,168 +0,0 @@ -import sinon = require('sinon'); -import expect = require('./expect'); -import { Actor, PerformsTasks, Question, Task, UsesAbilities } from '../src/screenplay'; - -import { step } from '../src/recording'; -import { Journal, StageManager } from '../src/stage/stage_manager'; - -describe ('When recording', () => { - - let alice: Actor, - stage_manager: StageManager; - - beforeEach(() => { - stage_manager = new StageManager(new Journal()); - alice = new Actor('Alice', stage_manager); - }); - - describe ('Actor', () => { - describe('performing activities that follow', () => { - - describe('Serenity BDD-style implementation', () => { - - class Follow implements Task { - - static the = (personOfInterest: string) => new Follow(personOfInterest); - - @step('{0} follows the #personOfInterest') - performAs(actor: PerformsTasks): PromiseLike { - return Promise.resolve(); - } - - constructor(private personOfInterest: string) { - } - } - - it('notifies the Stage Manager when the activity starts and finishes', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries).to.have.lengthOf(2); - expect(entries[ 0 ].value).to.deep.equal(entries[ 1 ].value.subject); - })); - - it('notifies the Stage Manager of Activity\'s invocation location', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries[ 0 ].value).to.be.recorded.as('Alice follows the white rabbit').calledAt({ - line: 43, - column: 97, - path: '/recording.spec.ts', - }); - })); - }); - - describe('ES6-style implementation', () => { - - class Follow implements Task { - - static the = (personOfInterest: string) => new Follow(personOfInterest); - - performAs(actor: PerformsTasks): PromiseLike { - return Promise.resolve(); - } - - toString = () => `{0} follows the ${ this.personOfInterest }`; - - constructor(private personOfInterest: string) { - } - } - - it('notifies the Stage Manager when the activity starts and finishes', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries).to.have.lengthOf(2); - expect(entries[ 0 ].value).to.deep.equal(entries[ 1 ].value.subject); - })); - - it('notifies the Stage Manager of Activity\'s invocation location', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries[ 0 ].value).to.be.recorded.as('Alice follows the white rabbit').calledAt({ - line: 77, - column: 97, - path: '/recording.spec.ts', - }); - })); - }); - - describe('minimalist implementation', () => { - - const Follow = { - the: (person_of_interest: string) => Task.where(`{0} follows the ${person_of_interest}`), - }; - - it('notifies the Stage Manager when the activity starts and finishes', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries).to.have.lengthOf(2); - expect(entries[ 0 ].value).to.deep.equal(entries[ 1 ].value.subject); - })); - - it('notifies the Stage Manager of Activity\'s invocation location', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries[ 0 ].value).to.be.recorded.as('Alice follows the white rabbit').calledAt({ - line: 101, - column: 97, - path: '/recording.spec.ts', - }); - })); - }); - - describe('data-driven approach', () => { - - class Destinations implements Question> { - - static available(): Question> { - return new Destinations(); - } - - answeredBy(actor: UsesAbilities): PromiseLike { - return Promise.resolve([ 'The Wonderland' ]); - } - } - - const Walk = { - towards: (destination: string) => Task.where(`{0} walks towards ${destination}`), - }; - - class Follow implements Task { - static the = (person_of_interest: string) => new Follow(person_of_interest); - - performAs(actor: PerformsTasks & UsesAbilities): PromiseLike { - const availableDestinations = [ 'The Wonderland' ]; - - return Destinations.available().answeredBy(actor).then(destinations => { - return actor.attemptsTo( - ...destinations.map(destination => - Walk.towards(destination), - ), - ); - }); - } - - toString = () => `{0} follows the ${this.person_of_interest}` - - constructor(private person_of_interest: string) { - } - } - - it('notifies the Stage Manager of Activity\'s invocation location', () => alice.attemptsTo(Follow.the('white rabbit')).then(() => { - const entries = stage_manager.readTheJournal(); - - expect(entries[ 0 ].value).to.be.recorded.as('Alice follows the white rabbit').calledAt({ - line: 150, - column: 97, - path: '/recording.spec.ts', - }); - - expect(entries[ 1 ].value).to.be.recorded.as('Alice walks towards The Wonderland').calledAt({ - line: 136, - column: 52, - path: '/recording.spec.ts', - }); - })); - }); - }); - }); -}); diff --git a/packages/core/spec/recording/activity_description.spec.ts b/packages/core/spec/recording/activity_description.spec.ts deleted file mode 100644 index 41c2aec5411..00000000000 --- a/packages/core/spec/recording/activity_description.spec.ts +++ /dev/null @@ -1,55 +0,0 @@ -import { given } from 'mocha-testdata'; - -import { describeAs } from '../../src/recording/activity_description'; -import { Actor, PerformsTasks, Task } from '../../src/screenplay'; - -import expect = require('../expect'); - -describe('Description of an Activity', () => { - - class PayWithCreditCard implements Task { - static number(creditCardNumber: string) { - return new PayWithCreditCard(creditCardNumber); - } - - constructor(private cardNumber: string, private expiryDate?: string[]) {} - - performAs(actor: PerformsTasks): Promise { - return actor.attemptsTo( - // interact with the application to input the data - ); - } - - toString = () => describeAs('#actor pays with a credit card ending #lastFourDigits', this); - - private lastFourDigits = () => this.cardNumber.slice(-4); - } - - given( - [ describeAs('{1}, {0}; age: {2}', 'John', 'Smith', 47), 'Smith, John; age: 47' ], - [ describeAs('{0} selects a product', Actor.named('Emma')), 'Emma selects a product' ], - [ describeAs('#actor selects a product', Actor.named('Emma')), 'Emma selects a product' ], - [ describeAs('#first #last', { first: 'Jan', last: 'Molak' }), 'Jan Molak' ], - [ describeAs('#first #last', { last: 'Bond' }), '#first Bond' ], - [ describeAs('products: #list', { list: ['apples', 'oranges'] }), 'products: apples, oranges' ], - ). - it ('can be parametrised', (result, expected) => expect(result).to.equal(expected)); - - it ('can include the properties of an Activity', () => { - - const activity = PayWithCreditCard.number('4111 1111 1111 1234'); - - expect(activity.toString()).to.equal('#actor pays with a credit card ending 1234'); - }); - - it ('interpolates field tokens before taking argument tokens into consideration', () => { - const activity = { - products: () => ['apples', 'oranges'], - performAs: (actor: PerformsTasks) => actor.attemptsTo(), - toString: () => describeAs('{0} adds #products to the basket', activity), - }; - - expect(activity.toString()).to.equal('{0} adds apples, oranges to the basket'); - }); - -}); diff --git a/packages/core/spec/recording/step_annotation.spec.ts b/packages/core/spec/recording/step_annotation.spec.ts deleted file mode 100644 index 2ed06384418..00000000000 --- a/packages/core/spec/recording/step_annotation.spec.ts +++ /dev/null @@ -1,191 +0,0 @@ -import { Task } from '../../src/screenplay/activities'; -import { Actor, PerformsTasks } from '../../src/screenplay/actor'; -import { Journal, StageManager } from '../../src/stage'; - -import { ActivityFinished, ActivityStarts, Outcome, RecordedActivity, Result } from '../../src/domain'; -import { step } from '../../src/recording/step_annotation'; - -import expect = require('../expect'); - -import StackTrace = require('stacktrace-js'); - -describe('Notifiers', () => { - - const - stage_manager = new StageManager(new Journal()), - bruce = new Actor('Bruce', stage_manager); - - describe('@step', () => { - - describe('When an annotated Task or Interaction is performed by the Actor', () => { - - describe('When all goes well', () => { - - class PayWithCreditCard implements Task { - static number(creditCardNumber: string) { - return new PayWithCreditCard(creditCardNumber); - } - - constructor(private cardNumber: string) { - } - - @step('{0} pays with a credit card number #obfuscatedCardNumber') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo( /*...*/ ); - } - - private obfuscatedCardNumber() { - return [this.cardNumber.slice(0, 4), 'XXXX', 'XXXX', 'XXXX'].join(' '); - } - } - - it('Notifies the Stage Manager when the Activity starts', () => { - - return bruce.attemptsTo(PayWithCreditCard.number('4111 1111 1111 1111')).then(() => { - - const newJournalEntries = stage_manager.readNewJournalEntriesAs('unit-test'); - - expect(newJournalEntries).to.have.lengthOf(2); - - expect(newJournalEntries[ 0 ]).to.be.instanceOf(ActivityStarts); - expect(newJournalEntries[ 0 ].value).to.be.instanceOf(RecordedActivity); - expect(newJournalEntries[ 0 ].value.name).to.equal('Bruce pays with a credit card number 4111 XXXX XXXX XXXX'); - }); - }); - - it('Notifies the Stage Manager when the Activity finishes successfully', () => { - - return bruce.attemptsTo(PayWithCreditCard.number('4111 1111 1111 1111')).then(() => { - - const newJournalEntries = stage_manager.readNewJournalEntriesAs('unit-test'); - - expect(newJournalEntries).to.have.lengthOf(2); - - expect(newJournalEntries[ 1 ]).to.be.instanceOf(ActivityFinished); - expect(newJournalEntries[ 1 ].value).to.be.instanceOf(Outcome); - - expect(newJournalEntries[ 1 ].value.subject).to.be.instanceOf(RecordedActivity); - expect(newJournalEntries[ 1 ].value.subject.name).to.equal('Bruce pays with a credit card number 4111 XXXX XXXX XXXX'); - }); - }); - - it('Knows its location to enable debugging and IDE support', () => { - return bruce.attemptsTo( - PayWithCreditCard.number('4111 1111 1111 1111'), - ).then(() => { - - const [ start, finish ] = stage_manager.readNewJournalEntriesAs('unit-test'); - - expect(start.value).to.be.recorded.calledAt({ - path: '/step_annotation.spec.ts', - line: 73, - column: 34, - }); - }); - }); - }); - - describe('When things go wrong and the Activity throws an Error', () => { - - class PayWithInvalidCreditCardThrowingAnError implements Task { - static number(creditCardNumber: string) { - return new PayWithInvalidCreditCardThrowingAnError(creditCardNumber); - } - - constructor(private cardNumber: string) {} - - @step('{0} pays with an invalid credit card number #cardNumber') - performAs(actor: PerformsTasks): PromiseLike { - throw new Error('Payment failed'); - } - } - - class PayWithInvalidCreditCardThrowingAnAssertionError implements Task { - static number(creditCardNumber: string) { - return new PayWithInvalidCreditCardThrowingAnAssertionError(creditCardNumber); - } - - constructor(private cardNumber: string) {} - - @step('{0} pays with an invalid credit card number #cardNumber') - performAs(actor: PerformsTasks): PromiseLike { - return expect(Promise.resolve(false)).to.eventually.equal(true); - } - } - - it('Notifies the Stage Manager when the Activity throws an Error', () => - - expect(bruce.attemptsTo(PayWithInvalidCreditCardThrowingAnError.number('1234 1234 1234 1234')) ). - to.be.rejected.then(() => { - - const lastEntry = stage_manager.readNewJournalEntriesAs('unit-test').pop(); - - expect(lastEntry.value.error.message).to.equal('Payment failed'); - expect(lastEntry.value.result).to.equal(Result.ERROR); - })); - - it('Notifies the Stage Manager when the Activity fails', () => - - expect(bruce.attemptsTo(PayWithInvalidCreditCardThrowingAnAssertionError.number('1234 1234 1234 1234'))). - to.be.rejected.then(() => { - - const lastEntry = stage_manager.readNewJournalEntriesAs('unit-test').pop(); - - expect(lastEntry.value.error.message).to.equal('expected false to equal true'); - expect(Result[lastEntry.value.result]).to.equal(Result[Result.FAILURE]); - })); - }); - - describe('When things go wrong and the Activity throws an Error', () => { - - class PayWithInvalidCreditCardRejectingAPromise implements Task { - static number(creditCardNumber: string) { - return new PayWithInvalidCreditCardRejectingAPromise(creditCardNumber); - } - - constructor(private cardNumber: string) { - } - - @step('{0} pays with an invalid credit card number #cardNumber') - performAs(actor: PerformsTasks): PromiseLike { - return Promise.reject(new Error('Payment failed')); - } - } - - it('Notifies the Stage Manager when the Activity fails due to a promise being rejected', () => - - expect(bruce.attemptsTo(PayWithInvalidCreditCardRejectingAPromise.number('1234 1234 1234 1234'))). - to.be.rejected.then(() => { - - const lastEntry = stage_manager.readNewJournalEntriesAs('unit-test').pop(); - - expect(lastEntry.value.error.message).to.equal('Payment failed'); - expect(lastEntry.value.result).to.equal(Result.ERROR); - })); - }); - - describe('Automatic migration from @step to toString()', () => { - - class AnnotatedTask implements Task { - private style = 'annotated'; - - @step('{0} performs an #style task') - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo(/* perform some tasks */); - } - } - - it ('adds a toString() method to the task if it is not present', () => { - - const task = new AnnotatedTask(); - - return expect(bruce.attemptsTo(task)).to.be.fulfilled.then(() => { - - expect(task.toString()).to.equal('{0} performs an annotated task'); - }); - }); - }); - }); - - }); -}); diff --git a/packages/core/spec/reporting/console_reporter.spec.ts b/packages/core/spec/reporting/console_reporter.spec.ts deleted file mode 100644 index fd3585f1bd4..00000000000 --- a/packages/core/spec/reporting/console_reporter.spec.ts +++ /dev/null @@ -1,96 +0,0 @@ -import { - ActivityFinished, - ActivityStarts, - Outcome, - Photo, - PhotoAttempted, - PhotoReceipt, - RecordedActivity, - RecordedScene, - Result, - SceneFinished, - SceneStarts, -} from '../../src/domain'; -import { Journal, Stage, StageManager } from '../../src/stage'; - -import sinon = require('sinon'); - -import expect = require('../expect'); -import { consoleReporter, ConsoleReporter } from '../../src/reporting/'; - -describe ('When reporting on what happened during the rehearsal', () => { - - describe ('Console Reporter', () => { - - const - startTime = 1467201010000, - scene = new RecordedScene('Paying with a default card', 'Checkout', { path: 'features/checkout.feature' }); - - it ('can be instantiated using a factory method', () => { - expect(consoleReporter()).to.be.instanceOf(ConsoleReporter); - }); - - it ('can be instantiated using a factory method and a custom message printer', () => { - expect(consoleReporter(console.error)).to.be.instanceOf(ConsoleReporter); - }); - - it ('prints any events it receives', () => { - const - print = sinon.spy(), - stage = new Stage(new StageManager(new Journal())), - reporter = new ConsoleReporter(print); - - reporter.assignTo(stage); - - stage.manager.notifyOf(sceneStarted(scene, startTime)); - stage.manager.notifyOf(activityStarted('Configures a default payment method', startTime + 1)); - stage.manager.notifyOf(activityFinished('Configures a default payment method', Result.SUCCESS, startTime + 2)); - stage.manager.notifyOf(photoTaken('Configures a default payment method', 'path/to/image.png', startTime + 3)); - stage.manager.notifyOf(sceneFinished(scene, Result.SUCCESS, startTime + 4)); - - expect(print).to.have.callCount(5); - - expect(print.getCall(0).args[0]).to.contain( - 'SceneStarts: Paying with a default card ' + - '(category: Checkout, path: features/checkout.feature, id: Checkout:Paying with a default card)', - ); - - expect(print.getCall(1).args[0]).to.contain( - 'ActivityStarts: Configures a default payment method', - ); - - expect(print.getCall(2).args[0]).to.contain( - 'ActivityFinished: Configures a default payment method (result: SUCCESS)', - ); - - expect(print.getCall(3).args[0]).to.contain( - 'PhotoAttempted: Configures a default payment method', - ); - - expect(print.getCall(4).args[0]).to.contain( - 'SceneFinished: Paying with a default card ' + - '(category: Checkout, path: features/checkout.feature, id: Checkout:Paying with a default card) (result: SUCCESS)', - ); - }); - - function sceneStarted(s: RecordedScene, timestamp: number) { - return new SceneStarts(s, timestamp); - } - - function activityStarted(name: string, timestamp: number) { - return new ActivityStarts(new RecordedActivity(name), timestamp); - } - - function activityFinished(name: string, r: Result, ts: number, e?: Error) { - return new ActivityFinished(new Outcome(new RecordedActivity(name), r, e), ts); - } - - function sceneFinished(s: RecordedScene, r: Result, timestamp: number, e?: Error) { - return new SceneFinished(new Outcome(s, r, e), timestamp); - } - - function photoTaken(name: string, path: string, timestamp: number) { - return new PhotoAttempted(new PhotoReceipt(new RecordedActivity(name), Promise.resolve(new Photo(path))), timestamp); - } - }); -}); diff --git a/packages/core/spec/reporting/serenity_bdd_reporter.spec.ts b/packages/core/spec/reporting/serenity_bdd_reporter.spec.ts deleted file mode 100644 index 44bf2c1c7a5..00000000000 --- a/packages/core/spec/reporting/serenity_bdd_reporter.spec.ts +++ /dev/null @@ -1,868 +0,0 @@ -import * as fs from 'fs'; -import * as mockfs from 'mock-fs'; -import { - ActivityFinished, - ActivityStarts, - DomainEvent, - Outcome, - Photo, - PhotoAttempted, - PhotoReceipt, - RecordedActivity, - RecordedScene, - Result, - SceneFinished, - SceneStarts, - SceneTagged, - Tag, -} from '../../src/domain'; -import { FileSystem } from '../../src/io/file_system'; -import { Journal, Stage, StageManager } from '../../src/stage'; - -import { SerenityBDDReporter, serenityBDDReporter } from '../../src/reporting/serenity_bdd_reporter'; - -import expect = require('../expect'); - -describe('When reporting on what happened during the rehearsal', () => { - - describe ('SerenityBDDReporter', () => { - - // todo: extract hash generation so that it doesn't have to be hard-coded - - const - startTime = 1467201010000, - duration = 42, - rootDir = `/path/to/project`, - requirementsDir = `${rootDir}/features`, - outputDir = `${rootDir}/target/site/serenity`, - - scene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }); - - let stageManager: StageManager, - stage: Stage, - fileSystem: FileSystem, - reporter: SerenityBDDReporter; - - beforeEach(() => { - fileSystem = new FileSystem(outputDir); - stageManager = new StageManager(new Journal()); - stage = new Stage(stageManager); - - reporter = new SerenityBDDReporter(requirementsDir, fileSystem); - reporter.assignTo(stage); - }); - - beforeEach(() => mockfs({ '/Users/jan/projects/serenityjs': {} })); - afterEach (() => mockfs.restore()); - - it ('can be instantiated using a default path to the reports directory', () => { - expect(serenityBDDReporter()).to.be.instanceOf(SerenityBDDReporter); - }); - - it ('can be instantiated using a factory method so that explicit instantiation of the File System can be avoided', () => { - expect(serenityBDDReporter('/some/path/to/features')).to.be.instanceOf(SerenityBDDReporter); - }); - - describe ('the Rehearsal Report', () => { - - it('contains the story of what happened during a scene', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), - sceneFinished(scene, Result.SUCCESS, startTime + duration), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - startTime, - duration, - result: Result[Result.SUCCESS], - }))); - }); - - it('includes the details of what happened during specific activities', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Opens a browser', startTime + 1), - activityFinished('Opens a browser', Result.SUCCESS, startTime + 2), - sceneFinished(scene, Result.SUCCESS, startTime + 3), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 3, - testSteps: [ { - description: 'Opens a browser', - startTime: startTime + 1, - duration: 1, - result: 'SUCCESS', - children: [], - } ], - }))); - }); - - it('covers multiple activities', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Opens a browser', startTime + 1), - activityFinished('Opens a browser', Result.SUCCESS, startTime + 2), - activityStarted('Navigates to amazon.com', startTime + 3), - activityFinished('Navigates to amazon.com', Result.SUCCESS, startTime + 4), - sceneFinished(scene, Result.SUCCESS, startTime + 5), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 5, - testSteps: [ { - description: 'Opens a browser', - startTime: startTime + 1, - duration: 1, - result: 'SUCCESS', - children: [], - }, { - description: 'Navigates to amazon.com', - startTime: startTime + 3, - duration: 1, - result: 'SUCCESS', - children: [], - } ], - }))); - }); - - it('covers activities in detail, including sub-activities', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Buys a discounted e-book reader', startTime + 1), - activityStarted('Opens a browser', startTime + 2), - activityFinished('Opens a browser', Result.SUCCESS, startTime + 3), - activityStarted('Searches for discounted e-book readers', startTime + 4), - activityStarted('Navigates to amazon.com', startTime + 5), - activityFinished('Navigates to amazon.com', Result.SUCCESS, startTime + 6), - activityFinished('Searches for discounted e-book readers', Result.SUCCESS, startTime + 7), - activityFinished('Buys a discounted e-book reader', Result.SUCCESS, startTime + 8), - sceneFinished(scene, Result.SUCCESS, startTime + 9), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 9, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 7, - result: 'SUCCESS', - children: [ { - description: 'Opens a browser', - startTime: startTime + 2, - duration: 1, - result: 'SUCCESS', - children: [], - }, { - description: 'Searches for discounted e-book readers', - startTime: startTime + 4, - duration: 3, - result: 'SUCCESS', - children: [ { - description: 'Navigates to amazon.com', - startTime: startTime + 5, - duration: 1, - result: 'SUCCESS', - children: [], - } ], - } ], - } ], - }))); - }); - - describe('When working with photos', () => { - - it('contains pictures', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Specifies the default email address', startTime + 1), - photoTaken('Specifies the default email address', 'picture1.png', startTime + 1), - activityFinished('Specifies the default email address', Result.SUCCESS, startTime + 2), - photoTaken('Specifies the default email address', 'picture2.png', startTime + 2), - sceneFinished(scene, Result.SUCCESS, startTime + 3), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 3, - testSteps: [ { - description: 'Specifies the default email address', - startTime: startTime + 1, - duration: 1, - result: 'SUCCESS', - children: [], - screenshots: [ - { screenshot: 'picture1.png' }, - { screenshot: 'picture2.png' }, - ], - } ], - }))); - }); - - it('ignores the photos that have been attempted but failed (ie. because webdriver was not ready)', () => { - - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Buys a discounted e-book reader', startTime + 1), - activityFinished('Buys a discounted e-book reader', Result.SUCCESS, startTime + 2), - photoFailed('Buys a discounted e-book reader', startTime + 2), - sceneFinished(scene, Result.SUCCESS, startTime + 3), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 3, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 1, - result: 'SUCCESS', - children: [], - } ], - }))); - }); - - it('covers activities in detail, including photos for sub-activities', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), // current: scene - activityStarted('Buys a discounted e-book reader', startTime + 1), // current: buys, previous: scene - activityStarted('Opens a browser', startTime + 2), // current: opens, previous: buys - activityFinished('Opens a browser', Result.SUCCESS, startTime + 3), // current: buys, previous: _ - photoTaken('Opens a browser', 'opens_browser.png', startTime + 3), // current: opens, previous: - activityStarted('Searches for discounted e-book readers', startTime + 4), - activityStarted('Navigates to amazon.com', startTime + 5), - activityFinished('Navigates to amazon.com', Result.SUCCESS, startTime + 6), - photoTaken('Navigates to amazon.com', 'navigates.png', startTime + 6), - activityFinished('Searches for discounted e-book readers', Result.SUCCESS, startTime + 7), - photoTaken('Searches for discounted e-book readers', 'searches.png', startTime + 7), - activityFinished('Buys a discounted e-book reader', Result.SUCCESS, startTime + 8), - photoTaken('Buys a discounted e-book reader', 'buys.png', startTime + 8), - sceneFinished(scene, Result.SUCCESS, startTime + 9), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 9, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 7, - result: 'SUCCESS', - screenshots: [ - { screenshot: 'buys.png' }, - ], - children: [ { - description: 'Opens a browser', - startTime: startTime + 2, - duration: 1, - result: 'SUCCESS', - children: [], - screenshots: [ - { screenshot: 'opens_browser.png' }, - ], - }, { - description: 'Searches for discounted e-book readers', - startTime: startTime + 4, - duration: 3, - result: 'SUCCESS', - children: [ { - description: 'Navigates to amazon.com', - startTime: startTime + 5, - duration: 1, - result: 'SUCCESS', - children: [], - screenshots: [ - { screenshot: 'navigates.png' }, - ], - } ], - screenshots: [ - { screenshot: 'searches.png' }, - ], - } ], - } ], - }))); - }); - - it('covers activities in detail, including photos for sub-activities, even those deeply nested ones', () => { - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Buys a discounted e-book reader', startTime + 1), - activityStarted('Searches for discounted e-book readers', startTime + 4), - activityStarted('Navigates to amazon.com', startTime + 5), - activityStarted('Enters https://amazon.com in the search bar', startTime + 5), - activityFinished('Enters https://amazon.com in the search bar', Result.SUCCESS, startTime + 6), - photoTaken('Enters https://amazon.com in the search bar', 'enters_url.png', startTime + 6), - activityFinished('Navigates to amazon.com', Result.SUCCESS, startTime + 7), - photoTaken('Navigates to amazon.com', 'navigates.png', startTime + 7), - activityFinished('Searches for discounted e-book readers', Result.SUCCESS, startTime + 8), - photoTaken('Searches for discounted e-book readers', 'searches.png', startTime + 8), - activityFinished('Buys a discounted e-book reader', Result.SUCCESS, startTime + 9), - photoTaken('Buys a discounted e-book reader', 'buys.png', startTime + 9), - sceneFinished(scene, Result.SUCCESS, startTime + 10), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 10, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 8, - result: 'SUCCESS', - screenshots: [ - { screenshot: 'buys.png' }, - ], - children: [ { - description: 'Searches for discounted e-book readers', - startTime: startTime + 4, - duration: 4, - result: 'SUCCESS', - children: [ { - description: 'Navigates to amazon.com', - startTime: startTime + 5, - duration: 2, - result: 'SUCCESS', - children: [{ - description: 'Enters https://amazon.com in the search bar', - startTime: startTime + 5, - duration: 1, - result: 'SUCCESS', - children: [], - screenshots: [ - { screenshot: 'enters_url.png' }, - ], - }], - screenshots: [ - { screenshot: 'navigates.png' }, - ], - } ], - screenshots: [ - { screenshot: 'searches.png' }, - ], - } ], - } ], - }))); - }); - }); - - describe('When problems are encountered', () => { - - it('describes problems encountered', () => { - const error = new Error("We're sorry, something happened"); - - error.stack = [ - "Error: We're sorry, something happened", - ' at callFn (/fake/path/node_modules/mocha/lib/runnable.js:326:21)', - ' at Test.Runnable.run (/fake/path/node_modules/mocha/lib/runnable.js:319:7)', - // and so on - ].join('\n'); - - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Buys a discounted e-book reader', startTime + 1), - activityFinished('Buys a discounted e-book reader', Result.ERROR, startTime + 2, error), - sceneFinished(scene, Result.ERROR, startTime + 3, error), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 3, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 1, - result: 'ERROR', - children: [], - exception: { - errorType: 'Error', - message: "We're sorry, something happened", - stackTrace: [ { - declaringClass: '', - fileName: '/fake/path/node_modules/mocha/lib/runnable.js', - lineNumber: 326, - methodName: 'callFn()', - }, { - declaringClass: '', - fileName: '/fake/path/node_modules/mocha/lib/runnable.js', - lineNumber: 319, - methodName: 'Test.Runnable.run()', - } ], - }, - } ], - result: 'ERROR', - annotatedResult: 'ERROR', - testFailureCause: { - errorType: 'Error', - message: "We're sorry, something happened", - stackTrace: [ { - declaringClass: '', - fileName: '/fake/path/node_modules/mocha/lib/runnable.js', - lineNumber: 326, - methodName: 'callFn()', - }, { - declaringClass: '', - fileName: '/fake/path/node_modules/mocha/lib/runnable.js', - lineNumber: 319, - methodName: 'Test.Runnable.run()', - } ], - }, - }))); - }); - - it('describes test infrastructure problems encountered during the test', () => { - const error = new Error('Timeout of 1000ms exceeded.'); - error.stack = ''; // we don't care about the stack in this test - - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Buys a discounted e-book reader', startTime + 1), - sceneFinished(scene, Result.ERROR, startTime + 1001, error), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 1001, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 1000, - result: 'ERROR', - children: [], - exception: { - errorType: 'Error', - message: 'Timeout of 1000ms exceeded.', - stackTrace: [], - }, - } ], - result: 'ERROR', - annotatedResult: 'ERROR', - testFailureCause: { - errorType: 'Error', - message: 'Timeout of 1000ms exceeded.', - stackTrace: [], - }, - }))); - }); - - it('describes assertion errors that don\'t have a stacktrace', () => { - try { - expect(true).to.equal(false); - } catch (error) { - - givenFollowingEvents( - sceneStarted(scene, startTime), - activityStarted('Buys a discounted e-book reader', startTime + 1), - sceneFinished(scene, Result.ERROR, startTime + 1001, error), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 1001, - testSteps: [ { - description: 'Buys a discounted e-book reader', - startTime: startTime + 1, - duration: 1000, - result: 'ERROR', - children: [], - exception: { - errorType: 'AssertionError', - message: 'expected true to equal false', - stackTrace: [], - }, - } ], - result: 'ERROR', - annotatedResult: 'ERROR', - testFailureCause: { - errorType: 'AssertionError', - message: 'expected true to equal false', - stackTrace: [], - }, - }))); - } - }); - }); - - describe('When feature files are grouped in directories', () => { - - it('reports the top-most directory as a "Capability", if there is only one level of nesting', () => { - const - capabilityDirectoryName = 'online_payments', - expectedCapabilityName = 'Online payments', - featureName = 'Card payments', - scenarioName = 'Paying with a default card'; - - const aScene = new RecordedScene(scenarioName, featureName, { - path: `${requirementsDir}/${capabilityDirectoryName}/card_payments.feature`, - }); - - givenFollowingEvents( - sceneStarted(aScene, startTime), - sceneFinished(aScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('ad1d4103e40456fafdcae4d92f99a0a7.json')).to.deep.equal(expectedReportWith({ - id: 'paying-with-a-default-card;feature-onlinepayments-card-payments-capability-online-payments', - name: 'paying-with-a-default-card;feature-onlinepayments-card-payments-capability-online-payments', - duration: 1, - result: 'SUCCESS', - tags: [ { - name: `${expectedCapabilityName}/${featureName}`, - type: 'feature', - }, { - name: expectedCapabilityName, - type: 'capability', - } ], - userStory: { - id: 'card-payments', - path: 'online_payments/card_payments.feature', - storyName: 'Card payments', - type: 'feature', - }, - }))); - }); - - it('reports the themes and capabilities if there are two levels of nesting', () => { - const - themeDirectoryName = 'online_payments', - expectedThemeName = 'Online payments', - capabilityDirectoryName = 'card_payments', - expectedCapabilityName = 'Card payments', - featureName = 'Visa', - scenarioName = 'Paying with a default card'; - - const aScene = new RecordedScene(scenarioName, featureName, { - path: `${requirementsDir}/${themeDirectoryName}/${capabilityDirectoryName}/visa.feature`, - }); - - givenFollowingEvents( - sceneStarted(aScene, startTime), - sceneFinished(aScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('ebcfc6c234fd44e76183cb15dcc441d4.json')).to.deep.equal(expectedReportWith({ - id: 'paying-with-a-default-card;feature-cardpayments-visa-capability-online-payments-card-payments-theme-online-payments', - name: 'paying-with-a-default-card;feature-cardpayments-visa-capability-online-payments-card-payments-theme-online-payments', - duration: 1, - result: 'SUCCESS', - tags: [ { - name: `${expectedCapabilityName}/${featureName}`, - type: 'feature', - }, { - name: `${expectedThemeName}/${expectedCapabilityName}`, - type: 'capability', - }, { - name: expectedThemeName, - type: 'theme', - } ], - userStory: { - id: 'visa', - path: `${themeDirectoryName}/${capabilityDirectoryName}/visa.feature`, - storyName: featureName, - type: 'feature', - }, - }))); - }); - }); - - describe('When scenarios are tagged', () => { - - it('adds a tag for the feature covered', () => { - const aScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }); - - givenFollowingEvents( - sceneStarted(aScene, startTime), - sceneFinished(aScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport()).to.deep.equal(expectedReportWith({ - duration: 1, - result: 'SUCCESS', - tags: [ { - name: 'Checkout', - type: 'feature', - } ], - }))); - }); - - it('describes the simple tags encountered', () => { - const taggedScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }, [ - new Tag('regression'), - ]); - - givenFollowingEvents( - sceneStarted(taggedScene, startTime), - sceneFinished(taggedScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('c8e5d709480c45d6a0e19252e8808c57.json')).to.deep.equal(expectedReportWith({ - duration: 1, - id: 'paying-with-a-default-card;regression-feature-checkout', - name: 'paying-with-a-default-card;regression-feature-checkout', - result: 'SUCCESS', - tags: [{ - name: 'regression', - type: 'tag', - }, { - name: 'Checkout', - type: 'feature', - }], - }))); - }); - - it('describes the scenario as "manual" when it is tagged as such', () => { - const taggedScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }, [ - new Tag('manual'), - ]); - - givenFollowingEvents( - sceneStarted(taggedScene, startTime), - sceneFinished(taggedScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('8bab02c07b11ba0897286a8eea810e06.json')).to.deep.equal(expectedReportWith({ - duration: 1, - id: 'paying-with-a-default-card;manual-external-tests-manual-feature-checkout', - name: 'paying-with-a-default-card;manual-external-tests-manual-feature-checkout', - result: 'SUCCESS', - manual: true, - tags: [{ - name: 'manual', - type: 'tag', - }, { - name: 'Manual', - type: 'External Tests', - }, { - name: 'Checkout', - type: 'feature', - }], - }))); - }); - - it('describes the complex tags encountered', () => { - const taggedScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }, [ - new Tag('priority', [ 'must-have' ]), - ]); - - givenFollowingEvents( - sceneStarted(taggedScene, startTime), - sceneFinished(taggedScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('96cf0cdb5ee2d58911ae1cb503e58483.json')).to.deep.equal(expectedReportWith({ - duration: 1, - result: 'SUCCESS', - id: 'paying-with-a-default-card;priority-must-have-feature-checkout', - name: 'paying-with-a-default-card;priority-must-have-feature-checkout', - tags: [{ - name: 'must-have', - type: 'priority', - }, { - name: 'Checkout', - type: 'feature', - }], - }))); - }); - - it('adds in tags generated asynchronously', () => { - const aScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }); - - givenFollowingEvents( - sceneStarted(aScene, startTime), - sceneTagged(new Tag('browser', ['chrome']), startTime + 3), - sceneFinished(aScene, Result.SUCCESS, startTime + 2), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('472e6b3067206747491fb55dbf61c239.json')).to.deep.equal(expectedReportWith({ - id: 'paying-with-a-default-card;browser-chrome-feature-checkout', - name: 'paying-with-a-default-card;browser-chrome-feature-checkout', - duration: 2, - result: 'SUCCESS', - tags: [{ - name: 'chrome', - type: 'browser', - }, { - name: 'Checkout', - type: 'feature', - }], - }))); - }); - - it('specifies what "context icon" to use when the context tag is present', () => { - const aScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }); - - givenFollowingEvents( - sceneStarted(aScene, startTime), - sceneTagged(new Tag('context', ['chrome']), startTime + 3), - sceneFinished(aScene, Result.SUCCESS, startTime + 2), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('8ef92158f9b14acefaa3195907f0d519.json')).to.deep.equal(expectedReportWith({ - id: 'paying-with-a-default-card;context-chrome-feature-checkout', - name: 'paying-with-a-default-card;context-chrome-feature-checkout', - duration: 2, - result: 'SUCCESS', - tags: [{ - name: 'chrome', - type: 'context', - }, { - name: 'Checkout', - type: 'feature', - }], - context: 'chrome', - }))); - }); - - it('extracts the value of any @issues tags encountered and breaks them down to one tag per issue', () => { - const taggedScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }, [ - new Tag('issues', [ 'MY-PROJECT-123', 'MY-PROJECT-456' ]), - new Tag('issues', [ 'MY-PROJECT-789' ]), - ]); - - givenFollowingEvents( - sceneStarted(taggedScene, startTime), - sceneFinished(taggedScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('ff634f0cc40700bd59177d4e5ae57b02.json')).to.deep.equal(expectedReportWith({ - duration: 1, - result: 'SUCCESS', - id: 'paying-with-a-default-card;issue-my-project-123-issue-my-project-456-issue-my-project-789-feature-checkout', - name: 'paying-with-a-default-card;issue-my-project-123-issue-my-project-456-issue-my-project-789-feature-checkout', - tags: [{ - name: 'MY-PROJECT-123', - type: 'issue', - }, { - name: 'MY-PROJECT-456', - type: 'issue', - }, { - name: 'MY-PROJECT-789', - type: 'issue', - }, { - name: 'Checkout', - type: 'feature', - }], - issues: [ - 'MY-PROJECT-123', - 'MY-PROJECT-456', - 'MY-PROJECT-789', - ], - }))); - }); - - it('ensures that the extracted issue ids are unique', () => { - const taggedScene = new RecordedScene('Paying with a default card', 'Checkout', { path: `${requirementsDir}/checkout.feature` }, [ - new Tag('issues', [ 'MY-PROJECT-123', 'MY-PROJECT-456' ]), - new Tag('issue', [ 'MY-PROJECT-123' ]), - ]); - - givenFollowingEvents( - sceneStarted(taggedScene, startTime), - sceneFinished(taggedScene, Result.SUCCESS, startTime + 1), - ); - - return stageManager.waitForNextCue().then(_ => - expect(producedReport('e5519b45036f53dfc53934ff569b72d2.json')).to.deep.equal(expectedReportWith({ - duration: 1, - result: 'SUCCESS', - id: 'paying-with-a-default-card;issue-my-project-123-issue-my-project-456-issue-my-project-123-feature-checkout', - name: 'paying-with-a-default-card;issue-my-project-123-issue-my-project-456-issue-my-project-123-feature-checkout', - tags: [{ - name: 'MY-PROJECT-123', - type: 'issue', - }, { - name: 'MY-PROJECT-456', - type: 'issue', - }, { - name: 'Checkout', - type: 'feature', - }], - issues: [ - 'MY-PROJECT-123', - 'MY-PROJECT-456', - ], - }))); - }); - }); - - function givenFollowingEvents(...events: Array>) { - events.forEach(event => stage.manager.notifyOf(event)); - } - - function sceneStarted(s: RecordedScene, timestamp: number) { - return new SceneStarts(s, timestamp); - } - - function sceneTagged(tag: Tag, timestamp: number) { - return new SceneTagged(Promise.resolve(tag), timestamp); - } - - function activityStarted(name: string, timestamp: number) { - return new ActivityStarts(new RecordedActivity(name), timestamp); - } - - function activityFinished(name: string, r: Result, ts: number, e?: Error) { - return new ActivityFinished(new Outcome(new RecordedActivity(name), r, e), ts); - } - - function sceneFinished(s: RecordedScene, r: Result, timestamp: number, e?: Error) { - return new SceneFinished(new Outcome(s, r, e), timestamp); - } - - function photoTaken(name: string, path: string, timestamp: number) { - return new PhotoAttempted(new PhotoReceipt(new RecordedActivity(name), Promise.resolve(new Photo(path))), timestamp); - } - - function photoFailed(name, timestamp) { - return new PhotoAttempted(new PhotoReceipt(new RecordedActivity(name), Promise.resolve(undefined)), timestamp); - } - - function expectedReportWith(overrides: any) { - const report = { - // todo: does the id/name affect anything in the navigation of the report? - id: 'paying-with-a-default-card;feature-checkout', - name: 'paying-with-a-default-card;feature-checkout', - testSteps: [], - issues: [], - userStory: { - id: 'checkout', - storyName: 'Checkout', - path: 'checkout.feature', - // narrative: '\nIn order to make me feel a sense of accomplishment\nAs a forgetful person\nI want to ...', - type: 'feature', - }, - title: 'Paying with a default card', - description: '', - tags: [{ - name: 'Checkout', - type: 'feature', - }], - manual: false, - startTime, - duration: undefined, - result: 'SUCCESS', - annotatedResult: 'SUCCESS', - testSource: 'cucumber', - }; - - return Object.assign(report, overrides); - } - - function producedReport(filename: string = '183050024e32d5f68bd5c1f367308f04.json') { - return JSON.parse(fs.readFileSync(`${outputDir}/${filename}`).toString('ascii')); - } - }); - }); -}); diff --git a/packages/core/spec/screenplay.spec.ts b/packages/core/spec/screenplay.spec.ts deleted file mode 100644 index e2a0c2742c0..00000000000 --- a/packages/core/spec/screenplay.spec.ts +++ /dev/null @@ -1,248 +0,0 @@ -import { Ability, Actor, Interaction, PerformsTasks, Question, Task, UsesAbilities } from '../src/screenplay'; - -import expect = require('./expect'); -import sinon = require('sinon'); -import { SinonSpyCall } from '@types/sinon'; - -describe('Screenplay Pattern', () => { - - let acousticGuitar: AcousticGuitar; - - beforeEach(() => acousticGuitar = sinon.createStubInstance(AcousticGuitar) as any); - - describe('Actor', () => { - - it('can be identified by their name', () => { - - const actor = Actor.named('Chris'); - - expect(actor.toString()).to.equal('Chris'); - }); - - it('has Abilities allowing them to perform Actions and interact with a given Interface: a web browser, a REST API or a guitar', () => { - - const actor = Actor.named('Chris').whoCan(PlayAnInstrument.suchAs(acousticGuitar)); - - return actor.attemptsTo( - PlayAChord.called(Chords.AMajor), - ) - .then(() => { - expect(acousticGuitar.play).to.have.been.calledWith(Chords.AMajor); - }); - }); - - it('performs Tasks to accomplish their Business Goals', () => { - - const actor = Actor.named('Chris').whoCan(PlayAnInstrument.suchAs(acousticGuitar)); - - return actor.attemptsTo( - PerformASong.from(MusicSheets.Wild_Thing), - ) - .then(() => { - expect(invocation(0, acousticGuitar.play)).to.have.been.calledWith(Chords.AMajor); - expect(invocation(1, acousticGuitar.play)).to.have.been.calledWith(Chords.DMajor); - expect(invocation(2, acousticGuitar.play)).to.have.been.calledWith(Chords.EMajor); - }); - }); - - it('asks Questions about the state of the Interface', () => { - - const actor = Actor.named('Chris').whoCan(PlayAnInstrument.suchAs(acousticGuitar)); - - expect(actor.toSee(NumberOfGuitarStrings.left())).equal(6); - }); - - it('admits if it does not have the Abilities necessary to accomplish the given Action', () => { - const actor = Actor.named('Ben'); - - return expect(actor.attemptsTo(PlayAChord.called(Chords.AMajor))) - .to.be.eventually.rejectedWith('I don\'t have the ability to PlayAnInstrument, said Ben sadly.'); - }); - - function invocation(n: number, spy: any): SinonSpyCall { - return spy.getCall(n); - } - }); - - describe('Task', () => { - - it('describes high-level, business domain-focused activities, composed of either other Tasks or Actions', () => { - - const actor = sinon.createStubInstance(Actor) as any; - - PerformASong.from(MusicSheets.Wild_Thing).performAs(actor); - - expect(actor.attemptsTo).to.have.been.calledWith( - PlayAChord.called(Chords.AMajor), - PlayAChord.called(Chords.DMajor), - PlayAChord.called(Chords.EMajor), - ); - }); - - it('can be implemented as a placeholder to be "chunked down" later', () => { - const task = Task.where(`#actor doesn't have the interface to interact with yet`); - - expect(task).to.have.property('performAs'); - }); - }); - - describe('Interaction', () => { - it('describes low-level, Interface-focused activity, directly exercising the Actor\'s Ability to interact with said Interface', () => { - const - ability = PlayAnInstrument.suchAs(acousticGuitar), - play = sinon.stub(ability, 'play'), - actor = Actor.named('Chris').whoCan(ability), - action = PlayAChord.called(Chords.AMajor); - - action.performAs(actor); - - expect(play).to.have.been.calledWith(Chords.AMajor); - }); - - it('can be implemented as a one-liner', () => { - const Play = (chord: Chord) => Interaction.where(`#actor plays ${chord}`, actor => PlayAnInstrument.as(actor).play(chord)); - - expect(Play(Chords.AMajor)).to.have.property('performAs'); - }); - }); - - describe('Question', () => { - - it('can be implemented as a one-liner', () => { - const chris = Actor.named('Chris').whoCan(PlayAnInstrument.suchAs(acousticGuitar)); - - const NumberOfGuitarStringsLeft = () => Question.about(`the number of strings left`, actor => 6); - - expect(NumberOfGuitarStringsLeft().answeredBy(chris)).to.equal(6); - }); - }); - - describe('Ability', () => { - it('allows the Actor to interact with some external Interface, such as a web browser, an API, etc.', () => { - const actor = Actor.named('Chris').whoCan(PlayAnInstrument.suchAs(acousticGuitar)); - - expect(PlayAnInstrument.as(actor)).to.be.instanceOf(PlayAnInstrument); - expect(PlayAnInstrument.as(actor)).to.have.property('play'); - }); - }); - - class Chord { - constructor(public name: string, - private E_6TH: number, - private A_5TH: number, - private D_4TH: number, - private G_3RD: number, - private B_2ND: number, - private E_1ST: number) { - } - - toString = () => this.name; - } - - class Chords { - public static AMajor = new Chord('CSharpMinor7', 0, 0, 2, 2, 2, 0); - public static DMajor = new Chord('DMajor', 0, 0, 0, 2, 3, 2); - public static EMajor = new Chord('EMajor', 0, 2, 2, 1, 0, 0); - } - - class MusicSheet { - constructor(public chords: Chord[]) {}; - } - - class MusicSheets { - public static Wild_Thing = new MusicSheet([ Chords.AMajor, Chords.DMajor, Chords.EMajor ]); - } - - class PerformASong implements Task { - static from(musicSheet: MusicSheet) { - return new PerformASong(musicSheet); - } - - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo.apply(actor, this.playThe(this.musicSheet.chords)); - } - - constructor(private musicSheet: MusicSheet) { } - - private playThe(chords: Chord[]): Interaction[] { - return chords.map(chord => PlayAChord.called(chord)); - } - } - - class PlayAChord implements Interaction { - static called(chord: Chord) { - return new PlayAChord(chord); - } - - performAs(actor: UsesAbilities): PromiseLike { - return PlayAnInstrument.as(actor).play(this.chord); - } - - constructor(private chord: Chord) { - } - } - - class NumberOfGuitarStrings implements Question { - - static left(): Question { - return new NumberOfGuitarStrings(); - } - - answeredBy(actor: UsesAbilities): number { - return 6; - } - } - - interface Instrument { - play(chord: Chord): PromiseLike; - } - - class AcousticGuitar implements Instrument { - play(chord: Chord): PromiseLike { - // use some "guitar driver" to play the chord on the "real guitar" - return Promise.resolve(); - } - } - - class PlayAnInstrument implements Ability { - - /** - * Instantiates the Ability to PlayAnInstrument, allowing the Actor to PerformASong - * - * @param instrument - * @return {PlayAnInstrument} - */ - static suchAs(instrument: Instrument) { - return new PlayAnInstrument(instrument); - } - - /** - * Used to access the Actor's ability to Drive from within the Action classes - * - * @param actor - * @return {PlayAnInstrument} - */ - static as(actor: UsesAbilities): PlayAnInstrument { - return actor.abilityTo(PlayAnInstrument); - } - - /** - * Instrument-specific interface, allowing the actor to interact with it. - * If it the Ability was to BrowseTheWeb, instead of "play" method it'd have had methods - * such as "findElementById" - * - * @param chord - */ - play(chord: Chord): PromiseLike { - return this.instrument.play(chord); - } - - /** - * The Ability to PlayAnInstrument allows the Actor to interact with an Instrument, - * in the same way as the Ability to BrowseTheWeb allows to interact with a WebDriver Browser - * - * @param instrument - */ - constructor(private instrument: Instrument) { } - } -}); diff --git a/packages/core/spec/screenplay/activities/ActivityDescriber.spec.ts b/packages/core/spec/screenplay/activities/ActivityDescriber.spec.ts new file mode 100644 index 00000000000..e0f10f3dccf --- /dev/null +++ b/packages/core/spec/screenplay/activities/ActivityDescriber.spec.ts @@ -0,0 +1,9 @@ +import 'mocha'; + +import { expect } from '../../expect'; +import { Task } from '../../../src/screenplay'; + +describe('ActivityDescriber', () => { + + +}); diff --git a/packages/core/spec/screenplay/actor/Actor.spec.ts b/packages/core/spec/screenplay/actor/Actor.spec.ts new file mode 100644 index 00000000000..8bf71b90dbb --- /dev/null +++ b/packages/core/spec/screenplay/actor/Actor.spec.ts @@ -0,0 +1,130 @@ +import 'mocha'; + +import * as sinon from 'sinon'; + +import { + ActivityBegins, + ActivityDetails, + ActivityFinished, + ExecutionSuccessful, + Name, + Timestamp, +} from '../../../src/domain'; +import { Actor, See } from '../../../src/screenplay'; +import { Clock, StageManager } from '../../../src/stage'; +import { expect } from '../../expect'; +import { Recorder } from '../../Recorder'; +import { + AcousticGuitar, + Chords, + Guitar, + MusicSheets, + NumberOfGuitarStringsLeft, + PlayAChord, + PlayAGuitar, + PlayASong, +} from '../example-implementation'; + +const equals = (expected: number) => (actual: PromiseLike) => expect(actual).to.eventually.equal(expected); + +describe('Actor', () => { + + let guitar: sinon.SinonStubbedInstance; + beforeEach(() => { + guitar = sinon.createStubInstance(AcousticGuitar); + }); + + it('can be identified by their name', () => { + + const actor = Actor.named('Chris'); + + expect(actor.toString()).to.equal('Chris'); + }); + + it('has Abilities allowing them to perform Activities and interact with a given Interface of the system under test', () => + + Actor.named('Chris').whoCan(PlayAGuitar.suchAs(guitar)).attemptsTo( + PlayAChord.of(Chords.AMajor), + ). + then(() => { + expect(guitar.play).to.have.been.calledWith(Chords.AMajor); + })); + + it('performs composite Tasks recursively to accomplish their Business Goals', () => + + Actor.named('Chris').whoCan(PlayAGuitar.suchAs(guitar)).attemptsTo( + PlayASong.from(MusicSheets.Wild_Thing), + ). + then(() => { + expect(guitar.play.getCall(0)).to.have.been.calledWith(Chords.AMajor); + expect(guitar.play.getCall(1)).to.have.been.calledWith(Chords.DMajor); + expect(guitar.play.getCall(2)).to.have.been.calledWith(Chords.EMajor); + })); + + describe('asks Questions about the state of the system', () => { + it('fulfills the promise should the question be answered as expected', () => { + guitar.availableStrings.returns(Promise.resolve(['E2', 'A2', 'D3', 'G3', 'B3', 'E4' ])); + + return expect(Actor.named('Chris').whoCan(PlayAGuitar.suchAs(guitar)).attemptsTo( + PlayASong.from(MusicSheets.Wild_Thing), + See.if(NumberOfGuitarStringsLeft(), equals(6)), + )).to.be.fulfilled; + }); + + it('rejects the promise should the answer differ from what was expected', () => { + const oneStringMissing = ['E2', 'A2', 'D3', 'G3', 'B3' ]; + guitar.availableStrings.returns(Promise.resolve(oneStringMissing)); + + return expect(Actor.named('Chris').whoCan(PlayAGuitar.suchAs(guitar)).attemptsTo( + PlayASong.from(MusicSheets.Wild_Thing), + See.if(NumberOfGuitarStringsLeft(), equals(6)), + )).to.be.rejectedWith('expected 5 to equal 6'); + }); + }); + + it('admits if it does not have the Ability necessary to accomplish a given Interaction', () => + + expect(Actor.named('Ben').attemptsTo( + PlayAChord.of(Chords.AMajor), + )).to.be.eventually.rejectedWith(`Ben can't PlayAGuitar yet. Did you give them the ability to do so?`)); + + describe('DomainEvent handling', () => { + + let clock: sinon.SinonStubbedInstance, + stageManager: StageManager, + recorder: Recorder, + Bob: Actor; + + beforeEach(() => { + clock = sinon.createStubInstance(Clock); + clock.now.returns(new Timestamp(new Date('2018-06-10T22:57:07.112Z'))); + + stageManager = new StageManager(clock); + + recorder = new Recorder(); + recorder.assignTo(stageManager); + + Bob = new Actor('Bob', stageManager, clock); + }); + + describe('notifies the StageManager of the activities it performs', () => { + + const details = new ActivityDetails( + new Name('Bob plays the chord of A'), + ); + + it('notifies when an activity begins and ends', () => Bob.whoCan(PlayAGuitar.suchAs(guitar)).attemptsTo( + PlayAChord.of(Chords.AMajor), + ). + then(() => { + expect(recorder.events).to.have.lengthOf(2); + + expect(recorder.events[0]).to.equal(new ActivityBegins(details, clock.now())); + + expect(recorder.events[1]).to.equal(new ActivityFinished(details, new ExecutionSuccessful(), clock.now())); + })); + }); + + it('reacts to events and changes its behaviour'); + }); +}); diff --git a/packages/core/spec/screenplay/example-implementation/AcousticGuitar.ts b/packages/core/spec/screenplay/example-implementation/AcousticGuitar.ts new file mode 100644 index 00000000000..8fd313ecede --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/AcousticGuitar.ts @@ -0,0 +1,13 @@ +import { Chord } from './Chord'; +import { Guitar } from './Guitar'; + +export class AcousticGuitar implements Guitar { + availableStrings(): PromiseLike { + return Promise.resolve(['E2', 'A2', 'D3', 'G3', 'B3', 'E4']); + } + + play(chord: Chord): PromiseLike { + // use some "guitar driver" to play the chord on the "real guitar" + return Promise.resolve(); + } +} diff --git a/packages/core/spec/screenplay/example-implementation/Chord.ts b/packages/core/spec/screenplay/example-implementation/Chord.ts new file mode 100644 index 00000000000..6011de0403e --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/Chord.ts @@ -0,0 +1,12 @@ +export class Chord { + constructor(public readonly name: string, + private readonly E_6TH: number, + private readonly A_5TH: number, + private readonly D_4TH: number, + private readonly G_3RD: number, + private readonly B_2ND: number, + private readonly E_1ST: number) { + } + + toString = () => this.name; +} diff --git a/packages/core/spec/screenplay/example-implementation/Chords.ts b/packages/core/spec/screenplay/example-implementation/Chords.ts new file mode 100644 index 00000000000..b7188f51567 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/Chords.ts @@ -0,0 +1,7 @@ +import { Chord } from './Chord'; + +export class Chords { + public static AMajor = new Chord('A', 0, 0, 2, 2, 2, 0); + public static DMajor = new Chord('D', 0, 0, 0, 2, 3, 2); + public static EMajor = new Chord('E', 0, 2, 2, 1, 0, 0); +} diff --git a/packages/core/spec/screenplay/example-implementation/Guitar.ts b/packages/core/spec/screenplay/example-implementation/Guitar.ts new file mode 100644 index 00000000000..38a077f07a1 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/Guitar.ts @@ -0,0 +1,6 @@ +import { Chord } from './Chord'; + +export interface Guitar { + play(chord: Chord): PromiseLike; + availableStrings(): PromiseLike; +} diff --git a/packages/core/spec/screenplay/example-implementation/MusicSheet.ts b/packages/core/spec/screenplay/example-implementation/MusicSheet.ts new file mode 100644 index 00000000000..e6a646fd493 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/MusicSheet.ts @@ -0,0 +1,6 @@ +import { Chord } from './Chord'; + +export class MusicSheet { + constructor(public chords: Chord[]) { + }; +} diff --git a/packages/core/spec/screenplay/example-implementation/MusicSheets.ts b/packages/core/spec/screenplay/example-implementation/MusicSheets.ts new file mode 100644 index 00000000000..e8d61cac1f5 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/MusicSheets.ts @@ -0,0 +1,6 @@ +import { Chords } from './Chords'; +import { MusicSheet } from './MusicSheet'; + +export class MusicSheets { + public static Wild_Thing = new MusicSheet([Chords.AMajor, Chords.DMajor, Chords.EMajor]); +} diff --git a/packages/core/spec/screenplay/example-implementation/abilities/PlayAGuitar.ts b/packages/core/spec/screenplay/example-implementation/abilities/PlayAGuitar.ts new file mode 100644 index 00000000000..1f0942d6411 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/abilities/PlayAGuitar.ts @@ -0,0 +1,49 @@ +import { Ability, UsesAbilities } from '../../../../src/screenplay'; +import { Chord } from '../Chord'; +import { Guitar } from '../Guitar'; + +export class PlayAGuitar implements Ability { + + /** + * Instantiates the Ability to PlayAnInstrument, allowing the Actor to PerformASong + * + * @param instrument + * @return {PlayAGuitar} + */ + static suchAs(instrument: Guitar) { + return new PlayAGuitar(instrument); + } + + /** + * Used to access the Actor's ability to Drive from within the Action classes + * + * @param actor + * @return {PlayAGuitar} + */ + static as(actor: UsesAbilities): PlayAGuitar { + return actor.abilityTo(PlayAGuitar); + } + + /** + * The Ability to PlayAnInstrument allows the Actor to interact with an Instrument, + * in the same way as the Ability to BrowseTheWeb allows to interact with a WebDriver Browser + * + * @param guitar + */ + constructor(private readonly guitar: Guitar) { } + + /** + * Instrument-specific interface, allowing the actor to interact with it. + * If it the Ability was to BrowseTheWeb, instead of "play" method it'd have had methods + * such as "findElementById" + * + * @param chord + */ + play(chord: Chord): PromiseLike { + return this.guitar.play(chord); + } + + availableStrings(): PromiseLike { + return this.guitar.availableStrings(); + } +} diff --git a/packages/core/spec/screenplay/example-implementation/abilities/index.ts b/packages/core/spec/screenplay/example-implementation/abilities/index.ts new file mode 100644 index 00000000000..df53d42806c --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/abilities/index.ts @@ -0,0 +1 @@ +export * from './PlayAGuitar'; diff --git a/packages/core/spec/screenplay/example-implementation/index.ts b/packages/core/spec/screenplay/example-implementation/index.ts new file mode 100644 index 00000000000..ba4f6e1f880 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/index.ts @@ -0,0 +1,10 @@ +export * from './abilities'; +export * from './interactions'; +export * from './questions'; +export * from './tasks'; +export * from './AcousticGuitar'; +export * from './Chord'; +export * from './Chords'; +export * from './Guitar'; +export * from './MusicSheet'; +export * from './MusicSheets'; \ No newline at end of file diff --git a/packages/core/spec/screenplay/example-implementation/interactions/PlayAChord.ts b/packages/core/spec/screenplay/example-implementation/interactions/PlayAChord.ts new file mode 100644 index 00000000000..a234d3a2908 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/interactions/PlayAChord.ts @@ -0,0 +1,18 @@ +import { Interaction, UsesAbilities } from '../../../../../core/src/screenplay'; +import { PlayAGuitar } from '../abilities'; +import { Chord } from '../Chord'; + +export class PlayAChord implements Interaction { + static of(chord: Chord) { + return new PlayAChord(chord); + } + + constructor(private chord: Chord) { + } + + performAs(actor: UsesAbilities): PromiseLike { + return PlayAGuitar.as(actor).play(this.chord); + } + + toString = () => `#actor plays the chord of ${ this.chord.name }`; +} diff --git a/packages/core/spec/screenplay/example-implementation/interactions/index.ts b/packages/core/spec/screenplay/example-implementation/interactions/index.ts new file mode 100644 index 00000000000..6cb6e08c48d --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/interactions/index.ts @@ -0,0 +1 @@ +export * from './PlayAChord'; diff --git a/packages/core/spec/screenplay/example-implementation/questions/NumberOfGuitarStringsLeft.ts b/packages/core/spec/screenplay/example-implementation/questions/NumberOfGuitarStringsLeft.ts new file mode 100644 index 00000000000..9cb31fac2a9 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/questions/NumberOfGuitarStringsLeft.ts @@ -0,0 +1,6 @@ +import { Question } from '../../../../src/screenplay'; +import { PlayAGuitar } from '../abilities'; + +export const NumberOfGuitarStringsLeft = () => Question.about>('number of guitar strings left', + actor => PlayAGuitar.as(actor).availableStrings().then(strings => strings.length), +); diff --git a/packages/core/spec/screenplay/example-implementation/questions/index.ts b/packages/core/spec/screenplay/example-implementation/questions/index.ts new file mode 100644 index 00000000000..1122e1fe31c --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/questions/index.ts @@ -0,0 +1 @@ +export * from './NumberOfGuitarStringsLeft'; diff --git a/packages/core/spec/screenplay/example-implementation/tasks/PlayASong.ts b/packages/core/spec/screenplay/example-implementation/tasks/PlayASong.ts new file mode 100644 index 00000000000..f99aea22a1f --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/tasks/PlayASong.ts @@ -0,0 +1,18 @@ +import { PerformsTasks, Task } from '../../../../../core/src/screenplay'; +import { PlayAChord } from '../interactions'; +import { MusicSheet } from '../MusicSheet'; + +export class PlayASong implements Task { + static from(musicSheet: MusicSheet) { + return new PlayASong(musicSheet); + } + + constructor(private readonly musicSheet: MusicSheet) { + } + + performAs(actor: PerformsTasks): PromiseLike { + return actor.attemptsTo( + ...this.musicSheet.chords.map(chord => PlayAChord.of(chord)), + ); + } +} diff --git a/packages/core/spec/screenplay/example-implementation/tasks/index.ts b/packages/core/spec/screenplay/example-implementation/tasks/index.ts new file mode 100644 index 00000000000..92bbc4d5610 --- /dev/null +++ b/packages/core/spec/screenplay/example-implementation/tasks/index.ts @@ -0,0 +1 @@ +export * from './PlayASong'; diff --git a/packages/core/spec/screenplay/interactions/See.spec.ts b/packages/core/spec/screenplay/interactions/See.spec.ts new file mode 100644 index 00000000000..0eecf121190 --- /dev/null +++ b/packages/core/spec/screenplay/interactions/See.spec.ts @@ -0,0 +1,50 @@ +import { AssertionError } from 'chai'; + +import { Actor, Question, See, UsesAbilities } from '../../../src/screenplay'; +import { expect } from '../../expect'; + +describe('Interactions', () => { + + describe('See', () => { + + describe('when used with async questions', () => { + const SomeAsyncResult = () => Question.about>('some async result', actor => Promise.resolve('some value')); + + it('allows the actor to verify a condition', () => { + const actor = Actor.named('James'); + + const promise = See.if(SomeAsyncResult(), r => expect(r).to.eventually.equal('some value')).performAs(actor); + + return expect(promise).to.be.eventually.fulfilled; + }); + + it('rejects the promise if the condition is not met', () => { + const actor = Actor.named('James'); + + const promise = See.if(SomeAsyncResult(), r => expect(r).to.eventually.equal('other value')).performAs(actor); + + return expect(promise).to.be.eventually.rejectedWith(AssertionError, `expected 'some value' to equal 'other value'`); + }); + }); + + describe('when used with sync questions', () => { + const SomeSyncResult = () => Question.about('some async result', actor => 'some value'); + + it('allows the actor to verify a condition', () => { + const actor = Actor.named('James'); + + const promise = See.if(SomeSyncResult(), r => expect(r).to.equal('some value')).performAs(actor); + + return expect(promise).to.be.eventually.fulfilled; + }); + + it('rejects the promise if the condition is not met', () => { + const actor = Actor.named('James'); + + const promise = See.if(SomeSyncResult(), r => expect(r).to.equal('other value')).performAs(actor); + + return expect(promise).to.be.eventually.rejectedWith(AssertionError, `expected 'some value' to equal 'other value'`); + }); + }); + }); +}); diff --git a/packages/core/spec/serenity.spec.ts b/packages/core/spec/serenity.spec.ts deleted file mode 100644 index b5375f90daa..00000000000 --- a/packages/core/spec/serenity.spec.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { DomainEvent } from '../src/domain/events'; -import { Serenity } from '../src/serenity'; -import { Stage } from '../src/stage/stage'; -import { StageCrewMember } from '../src/stage/stage_manager'; - -import expect = require('./expect'); - -class BestBoy implements StageCrewMember { - private assignToCalled = false; - assigned = (): boolean => this.assignToCalled; - - assignTo = (stage: Stage) => this.assignToCalled = true; - notifyOf = (event: DomainEvent) => undefined; // no-op -} - -describe('serenity', () => { - - it('is initialised with no stage crew', () => { - const serenity = new Serenity(); - - expect(serenity.config.crew).to.be.empty; // tslint:disable-line:no-unused-expression - }); - - it('can have the stage crew configured', () => { - const crewMember = new BestBoy(); - - const serenity = new Serenity(); - serenity.configure({ - crew: [ - crewMember, - ], - }); - - expect(serenity.config.crew).to.have.lengthOf(1); - expect(serenity.config.crew).to.deep.include(crewMember); - expect(crewMember.assigned()).to.be.true; // tslint:disable-line:no-unused-expression - }); -}); diff --git a/packages/core/spec/stage/StageManager.spec.ts b/packages/core/spec/stage/StageManager.spec.ts new file mode 100644 index 00000000000..9ec37da79e7 --- /dev/null +++ b/packages/core/spec/stage/StageManager.spec.ts @@ -0,0 +1,72 @@ +import 'mocha'; +import { AsyncOperationAttempted, DomainEvent } from '../../src/domain'; +import { StageCrewMember, StageManager } from '../../src/stage'; + +import { expect } from '../expect'; +import { Recorder } from '../Recorder'; + +describe('StageManager', () => { + + class TestEvent extends DomainEvent { + constructor() { + super(); + } + } + + class TestStageCrewMember implements StageCrewMember { + assignTo(stageManager: StageManager): void { + stageManager.register(this); + } + + notifyOf(event: DomainEvent): void { + // ignore + } + } + + const testEvent = new TestEvent(); + + it('broadcasts the domain event it receives to all the registered subscribers', () => { + + const stageManager = new StageManager(); + const crewMember1 = new Recorder(); + const crewMember2 = new Recorder(); + + crewMember1.assignTo(stageManager); + crewMember2.assignTo(stageManager); + + stageManager.notifyOf(testEvent); + + expect(crewMember1.events).to.have.lengthOf(1); + expect(crewMember1.events[0]).to.be.instanceOf(TestEvent); + expect(crewMember2.events).to.have.lengthOf(1); + expect(crewMember2.events[0]).to.be.instanceOf(TestEvent); + }); + + it('keeps track of the work in progress', () => { + + const stageManager = new StageManager(); + + stageManager.notifyOf(new AsyncOperationAttempted( + TestStageCrewMember, + 'perform task', + Promise.resolve(), + )); + + return expect(stageManager.waitForNextCue()).to.be.fulfilled; + }); + + it('provides details should the work in progress fail to complete', () => { + + const stageManager = new StageManager(); + + stageManager.notifyOf(new AsyncOperationAttempted( + TestStageCrewMember, + 'perform some task', + Promise.reject(new Error('something broke')), + )); + + return expect(stageManager.waitForNextCue()).to.be.rejected.then(error => { + expect(error.message).to.match(/^TestStageCrewMember took \d+ms to perform some task and has failed$/); + }); + }); +}); diff --git a/packages/core/spec/stage/crew/artifact-archiver/ArtifactArchiver.spec.ts b/packages/core/spec/stage/crew/artifact-archiver/ArtifactArchiver.spec.ts new file mode 100644 index 00000000000..2c3ac7afa0a --- /dev/null +++ b/packages/core/spec/stage/crew/artifact-archiver/ArtifactArchiver.spec.ts @@ -0,0 +1,96 @@ +import 'mocha'; +import * as sinon from 'sinon'; + +import { ArtifactGenerated, AsyncOperationAttempted, DomainEvent, Name } from '../../../../src/domain'; +import { Artifact, FileSystem, FileType, Path } from '../../../../src/io'; +import { ArtifactArchiver, StageManager } from '../../../../src/stage'; +import { given } from '../given'; + +import { expect } from '../../../expect'; +import { photo } from '../samples'; + +describe('ArtifactArchiver', () => { + + let stageManager: sinon.SinonStubbedInstance, + fs: sinon.SinonStubbedInstance, + archiver: ArtifactArchiver; + + beforeEach(() => { + fs = sinon.createStubInstance(FileSystem); + stageManager = sinon.createStubInstance(StageManager); + + archiver = new ArtifactArchiver(fs as any); + archiver.assignTo(stageManager as any); + + fs.store.returns(Promise.resolve(new Path('/some/absolute/path/to/the/artifact'))); + }); + + describe('stores the artifacts generated by the other stage crew members', () => { + + const + artifactName = new Name('expected-file-name'), + json = { key: 'value' }, + expectedJsonFilename = [ artifactName.value, FileType.JSON.extesion.value ].join('.'), + expectedPngFilename = [ artifactName.value, FileType.PNG.extesion.value ].join('.'); + + it('publishes an event which promise will be resolved when the file is correctly stored on the file system', () => { + given(archiver).isNotifiedOfFollowingEvents( + new ArtifactGenerated(new Artifact(artifactName, FileType.JSON, json)), + ); + + expect(stageManager.notifyOf.callCount).to.equal(1); + + const asyncOperationAttempted = stageManager.notifyOf.firstCall.lastArg; + + expect(asyncOperationAttempted).to.be.instanceOf(AsyncOperationAttempted); + expect(asyncOperationAttempted.crewMember).to.equal(ArtifactArchiver); + expect(asyncOperationAttempted.taskDescription).to.equal(`save '${ expectedJsonFilename }'`); + + return expect(asyncOperationAttempted.value).to.be.fulfilled; + }); + + it('correctly saves JSON content to a file', () => { + given(archiver).isNotifiedOfFollowingEvents( + new ArtifactGenerated(new Artifact(artifactName, FileType.JSON, json)), + ); + + const asyncOperationAttempted = stageManager.notifyOf.firstCall.lastArg; + + return expect(asyncOperationAttempted.value).to.be.fulfilled.then(_ => { + expect(fs.store).to.have.been.calledWith(new Path(expectedJsonFilename), JSON.stringify(json)); + }); + }); + + it('correctly saves PNG content to a file', () => { + given(archiver).isNotifiedOfFollowingEvents( + new ArtifactGenerated(new Artifact(artifactName, FileType.PNG, photo.value)), + ); + + const asyncOperationAttempted = stageManager.notifyOf.firstCall.lastArg; + + return expect(asyncOperationAttempted.value).to.be.fulfilled.then(_ => { + expect(fs.store).to.have.been.calledWith(new Path(expectedPngFilename), photo.value, 'base64'); + }); + }); + }); + + describe(`when it encounters events it's not interested in`, () => { + + class SomeEvent extends DomainEvent { + constructor() { + super(); + } + } + + const someEvent = new SomeEvent(); + + it(`ignores them`, () => { + given(archiver).isNotifiedOfFollowingEvents( + someEvent, + ); + + expect(stageManager.notifyOf).to.not.have.been.of; // tslint:ignore-line:no-unused-expression + expect(fs.store).to.not.have.been.of; // tslint:ignore-line:no-unused-expression + }); + }); +}); diff --git a/packages/core/spec/stage/crew/given.ts b/packages/core/spec/stage/crew/given.ts new file mode 100644 index 00000000000..a9b7779ae3a --- /dev/null +++ b/packages/core/spec/stage/crew/given.ts @@ -0,0 +1,10 @@ +import { DomainEvent } from '../../../src/domain'; +import { StageCrewMember } from '../../../src/stage'; + +export function given(crewMember: StageCrewMember) { + return ({ + isNotifiedOfFollowingEvents: (...events: DomainEvent[]) => { + events.forEach(event => crewMember.notifyOf(event)); + }, + }); +} diff --git a/packages/core/spec/stage/crew/samples.ts b/packages/core/spec/stage/crew/samples.ts new file mode 100644 index 00000000000..31d0f65d691 --- /dev/null +++ b/packages/core/spec/stage/crew/samples.ts @@ -0,0 +1,20 @@ +import { Category, Name, Photo, ScenarioDetails } from '../../../src/domain'; +import { FileSystemLocation, Path } from '../../../src/io'; + +export const defaultCardScenario = new ScenarioDetails( + new Name('Paying with a default card'), + new Category('Online Checkout'), + new FileSystemLocation( + new Path(`payments/checkout.feature`), + ), +); + +export const voucherScenario = new ScenarioDetails( + new Name('Paying with a voucher'), + new Category('Online Checkout'), + new FileSystemLocation( + new Path(`payments/checkout.feature`), + ), +); + +export const photo = new Photo('iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEW01FWbeM52AAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=='); diff --git a/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.spec.ts b/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.spec.ts new file mode 100644 index 00000000000..ef41f628565 --- /dev/null +++ b/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.spec.ts @@ -0,0 +1,337 @@ +import 'mocha'; + +import * as sinon from 'sinon'; + +import { + ArtifactGenerated, + AssertionFailed, + Category, + Duration, + ErrorOccurred, + ExecutionCompromised, + ExecutionContextPropertyDetected, + ExecutionIgnored, + ExecutionSkipped, + ExecutionSuccessful, + ImplementationPending, + Name, + ScenarioDetails, + SceneBegins, + SceneFinished, + TestRunnerType, + Timestamp, +} from '../../../../src/domain'; +import { TestCompromisedError } from '../../../../src/errors'; +import { Artifact, FileSystemLocation, FileType, Path } from '../../../../src/io'; +import { SerenityBDDReporter, StageManager } from '../../../../src/stage'; +import { SerenityBDDReport } from '../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema'; +import { expect } from '../../../expect'; +import { given } from '../given'; + +describe('SerenityBDDReporter', () => { + + const + startTime = Timestamp.fromJSON('2018-05-25T00:00:00.123Z'), + scenarioDuration = Duration.ofMillis(142); + + const defaultCardScenario = new ScenarioDetails( + new Name('Paying with a default card'), + new Category('Online Checkout'), + new FileSystemLocation( + new Path(`payments/checkout.feature`), + ), + ); + + const voucherScenario = new ScenarioDetails( + new Name('Paying with a voucher'), + new Category('Online Checkout'), + new FileSystemLocation( + new Path(`payments/checkout.feature`), + ), + ); + + let stageManager: sinon.SinonStubbedInstance, + reporter: SerenityBDDReporter; + + beforeEach(() => { + stageManager = sinon.createStubInstance(StageManager); + + reporter = new SerenityBDDReporter(); + reporter.assignTo(stageManager as any); + }); + + describe('generates a SerenityBDDReport Artifact that', () => { + + let artifact: Artifact; + + beforeEach(() => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + expect(stageManager.notifyOf.callCount).to.equal(1); + + artifact = stageManager.notifyOf.firstCall.lastArg.artifact; + }); + + it('is a JSON', () => { + expect(artifact.type).to.equal(FileType.JSON); + }); + + it('has a unique file name (MD5)', () => { + expect(artifact.name.value.length).to.equal(32); + expect(artifact.name.value).to.match(/[0-9a-e]+/); + }); + }); + + describe('emits an ArtifactGenerated event that', () => { + + it('is separate for each scenario', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + new SceneBegins(voucherScenario), + new SceneFinished(voucherScenario, new ExecutionIgnored()), + ); + + expect(stageManager.notifyOf.callCount).to.equal(2); + + const + event1: ArtifactGenerated = stageManager.notifyOf.firstCall.lastArg, + event2: ArtifactGenerated = stageManager.notifyOf.secondCall.lastArg; + + expect(event1.artifact.contents.name).to.equal(defaultCardScenario.name.value); + + expect(event2.artifact.contents.name).to.equal(voucherScenario.name.value); + expect(event2.artifact.contents.name).to.equal(voucherScenario.name.value); + }); + }); + + describe('produces a SerenityBDDReport that', () => { + + let report: SerenityBDDReport; + + describe('at the scenario level', () => { + + beforeEach(() => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario, startTime), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful(), startTime.plus(scenarioDuration)), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + }); + + it('contains the id of the scenario', () => { + expect(report.id).to.equal('online-checkout;paying-with-a-default-card'); + }); + + it('contains the name of the scenario', () => { + expect(report.name).to.equal(defaultCardScenario.name.value); + expect(report.title).to.equal(defaultCardScenario.name.value); + }); + + it('contains the start time of the scenario', () => { + expect(report.startTime).to.equal(startTime.toMillisecondTimestamp()); + }); + + it('contains the duration of the scenario', () => { + expect(report.duration).to.equal(scenarioDuration.milliseconds); + }); + }); + + describe('describes the result of scenario execution that', () => { + + beforeEach(() => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + ); + }); + + it('has finished with success', () => { + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('SUCCESS'); + }); + + it(`hasn't been implemented yet`, () => { + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ImplementationPending()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('PENDING'); + }); + + it('has been ignored', () => { + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ExecutionIgnored()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('IGNORED'); + }); + + it('has been skipped', () => { + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ExecutionSkipped()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('SKIPPED'); + }); + + it('has failed with an assertion error', () => { + + try { + expect(true).to.equal(false); + } catch (assertionError) { + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new AssertionFailed(assertionError)), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('FAILURE'); + expect(report.testFailureCause.errorType).to.equal('AssertionError'); + expect(report.testFailureCause.message).to.equal('expected true to equal false'); + expect(report.testFailureCause.stackTrace).to.be.an('array'); + } + }); + + it('has failed with a non-assertion error', () => { + const error = new Error("We're sorry, something happened"); + + error.stack = [ + "Error: We're sorry, something happened", + ' at callFn (/fake/path/node_modules/mocha/lib/runnable.js:326:21)', + ' at Test.Runnable.run (/fake/path/node_modules/mocha/lib/runnable.js:319:7)', + // and so on + ].join('\n'); + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ErrorOccurred(error)), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('ERROR'); + expect(report.testFailureCause).to.deep.equal({ + errorType: 'Error', + message: `We're sorry, something happened`, + stackTrace: [ { + declaringClass: '', + fileName: '/fake/path/node_modules/mocha/lib/runnable.js', + lineNumber: 326, + methodName: 'callFn()', + }, { + declaringClass: '', + fileName: '/fake/path/node_modules/mocha/lib/runnable.js', + lineNumber: 319, + methodName: 'Test.Runnable.run()', + } ], + }); + }); + + it('has been compromised', () => { + const error = new TestCompromisedError(`Test database not deployed, no point running the test`); + error.stack = [ + 'Error: Test database not deployed, no point running the test', + ' at callFn (/fake/path/node_modules/mocha/lib/runnable.js:326:21)', + // and so on + ].join('\n'); + + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ExecutionCompromised(error)), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.result).to.equal('COMPROMISED'); + expect(report.testFailureCause).to.deep.equal({ + errorType: 'Error', + message: `Test database not deployed, no point running the test`, + stackTrace: [ + { + declaringClass: '', + fileName: '/fake/path/node_modules/mocha/lib/runnable.js', + lineNumber: 326, + methodName: 'callFn()', + }, + ], + }); + }); + }); + + describe('indicates its execution context', () => { + + beforeEach(() => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + ); + }); + + it('specifies the test runner', () => { + given(reporter).isNotifiedOfFollowingEvents( + new ExecutionContextPropertyDetected(defaultCardScenario, new TestRunnerType('Cucumber')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.testSource).to.equal('Cucumber'); + }); + + it('specifies the user story covered', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.userStory).to.deep.equal({ + id: 'online-checkout', + storyName: 'Online Checkout', // category name, a.k.a. feature name + path: 'payments/checkout.feature', + type: 'feature', + }); + }); + + describe('reports information from the cucumber feature file', () => { + + it('reports the scenario-level narrative'); + it('reports the scenario-level background title'); + it('reports the scenario-level background description'); + }); + }); + }); + + describe('attachements', () => { + // screenshots + // html source + // http request/responses + // arbitrary text data + }); + + describe('Error handling', () => { + + // todo: node-cleanup + it('generates the report even when the test runner has crashed'); + }); +}); + +// todo: Does the scene need a correlation ID? +// todo: 'ParametrisedSceneBegins'(scenedetails, parameters) diff --git a/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/reporting_activities.spec.ts b/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/reporting_activities.spec.ts new file mode 100644 index 00000000000..4cf9d937d99 --- /dev/null +++ b/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/reporting_activities.spec.ts @@ -0,0 +1,106 @@ +import 'mocha'; + +import * as sinon from 'sinon'; + +import { + ActivityBegins, + ActivityDetails, + ActivityFinished, + ArtifactGenerated, + ExecutionSuccessful, + Name, + SceneBegins, + SceneFinished, +} from '../../../../../src/domain'; +import { Artifact, FileType } from '../../../../../src/io'; +import { SerenityBDDReporter, StageManager } from '../../../../../src/stage'; +import { SerenityBDDReport } from '../../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema'; +import { expect } from '../../../../expect'; +import { given } from '../../given'; +import { defaultCardScenario, photo } from '../../samples'; + +describe('SerenityBDDReporter', () => { + + let stageManager: sinon.SinonStubbedInstance, + reporter: SerenityBDDReporter; + + beforeEach(() => { + stageManager = sinon.createStubInstance(StageManager); + + reporter = new SerenityBDDReporter(); + reporter.assignTo(stageManager as any); + }); + + describe('reports the activities that took place during scenario execution:', () => { + + it('reports the outcome of a single activity', () => { + const pickACard = new ActivityDetails(new Name('Pick the default credit card')); + + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + new ActivityBegins(pickACard), + new ActivityFinished(pickACard, new ExecutionSuccessful()), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.testSteps).to.have.lengthOf(1); + expect(report.testSteps[0].description).to.equal(pickACard.name.value); + expect(report.testSteps[0].result).to.equal('SUCCESS'); + }); + + it('reports the outcome of nested activities', () => { + const pickACard = new ActivityDetails(new Name('Pick the default credit card')); + const viewListOfCards = new ActivityDetails(new Name('View the list of available cards')); + + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + new ActivityBegins(pickACard), + new ActivityBegins(viewListOfCards), + new ActivityFinished(viewListOfCards, new ExecutionSuccessful()), + new ActivityFinished(pickACard, new ExecutionSuccessful()), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.testSteps).to.have.lengthOf(1); + expect(report.testSteps[0].children).to.have.lengthOf(1); + expect(report.testSteps[0].children[0].description).to.equal(viewListOfCards.name.value); + expect(report.testSteps[0].children[0].result).to.equal('SUCCESS'); + }); + }); + + describe('order of events', () => { + + it('records the events in a correct order', () => { + const pickACard = new ActivityDetails(new Name('Pick the default credit card')); + + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + new ActivityBegins(pickACard), + new ArtifactGenerated(new Artifact( + new Name('photo1.png'), + FileType.PNG, + photo, + )), + new ActivityFinished(pickACard, new ExecutionSuccessful()), + new ArtifactGenerated(new Artifact( + new Name('photo2.png'), + FileType.PNG, + photo, + )), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.testSteps).to.have.lengthOf(1); + expect(report.testSteps[0].screenshots).to.deep.equal([ + { screenshot: 'photo1.png'}, + { screenshot: 'photo2.png'}, + ]); + }); + }); +}); diff --git a/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/tagging_scenarios.spec.ts b/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/tagging_scenarios.spec.ts new file mode 100644 index 00000000000..a7fd14b39f9 --- /dev/null +++ b/packages/core/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/tagging_scenarios.spec.ts @@ -0,0 +1,224 @@ +import 'mocha'; + +import * as sinon from 'sinon'; + +import { + ArbitraryTag, + BrowserTag, + CapabilityTag, + ContextTag, + ExecutionSuccessful, + FeatureTag, + IssueTag, + ManualTag, + SceneBegins, + SceneFinished, + SceneTagged, + ThemeTag, +} from '../../../../../src/domain'; +import { SerenityBDDReporter, StageManager } from '../../../../../src/stage'; +import { SerenityBDDReport } from '../../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema'; +import { expect } from '../../../../expect'; +import { given } from '../../given'; +import { defaultCardScenario } from '../../samples'; + +describe('SerenityBDDReporter', () => { + + let stageManager: sinon.SinonStubbedInstance, + reporter: SerenityBDDReporter; + + beforeEach(() => { + stageManager = sinon.createStubInstance(StageManager); + + reporter = new SerenityBDDReporter(); + reporter.assignTo(stageManager as any); + }); + + describe('produces a SerenityBDDReport that', () => { + + let report: SerenityBDDReport; + + describe('can be tagged', () => { + + beforeEach(() => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneBegins(defaultCardScenario), + ); + }); + + describe('@manual', () => { + + it('is marked as automated (non-manual) by default', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.manual).to.equal(false); + }); + + it('can be optionally tagged as manual', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new ManualTag()), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.manual).to.equal(true); + expect(report.tags).to.deep.include.members([{ + name: 'Manual', + type: 'External Tests', + }]); + }); + }); + + describe('@issue', () => { + it('can be tagged with an issue number', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new IssueTag('ABC-1234')), + new SceneTagged(defaultCardScenario, new IssueTag('DEF-5678')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.tags).to.deep.include.members([{ + name: 'ABC-1234', + type: 'issue', + }, { + name: 'DEF-5678', + type: 'issue', + }]); + + expect(report.issues).to.deep.equal([ + 'ABC-1234', + 'DEF-5678', + ]); + }); + }); + + describe('@arbitrary-tag', () => { + it('can be tagged with an arbitrary tag', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new ArbitraryTag('regression')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.tags).to.deep.include.members([{ + name: 'regression', + type: 'tag', + }]); + }); + }); + + describe('to indicate that a scenario', () => { + + it('belongs to a feature', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new FeatureTag('Checkout')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.tags).to.deep.include.members([{ + name: 'Checkout', + type: 'feature', + }]); + + expect(report.featureTag).to.deep.equal({ + name: 'Checkout', + type: 'feature', + }); + }); + + it('belongs to a capability', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new CapabilityTag('E-Commerce')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.tags).to.deep.include.members([{ + name: 'E-Commerce', + type: 'capability', + }]); + }); + + it('belongs to a theme', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new ThemeTag('Digital')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.tags).to.deep.include.members([{ + name: 'Digital', + type: 'theme', + }]); + }); + + describe('is executed in the context and', () => { + + it('indicates the web browser where the test was executed', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new BrowserTag('chrome')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.context).to.equal('chrome'); + + expect(report.tags).to.deep.include.members([{ + name: 'chrome', + type: 'browser', + }]); + }); + + it('indicates the operating system where the test was executed', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new ContextTag('iphone')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.context).to.equal('iphone'); + + expect(report.tags).to.deep.include.members([{ + name: 'iphone', + type: 'context', + }]); + }); + + it('ensures that the user-specified context takes precedence over browser context', () => { + given(reporter).isNotifiedOfFollowingEvents( + new SceneTagged(defaultCardScenario, new BrowserTag('safari')), + new SceneTagged(defaultCardScenario, new ContextTag('iphone')), + new SceneFinished(defaultCardScenario, new ExecutionSuccessful()), + ); + + report = stageManager.notifyOf.firstCall.lastArg.artifact.contents; + + expect(report.context).to.equal('iphone'); + + expect(report.tags).to.deep.include.members([{ + name: 'safari', + type: 'browser', + }, { + name: 'iphone', + type: 'context', + }]); + }); + }); + }); + }); + }); +}); diff --git a/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/failed.json b/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/failed.json new file mode 100644 index 00000000000..857d256d026 --- /dev/null +++ b/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/failed.json @@ -0,0 +1,172 @@ +{ + "name": "should_see_deleting_a_todo_decreases_the_remaining_items_count", + "testCaseName": "net.serenitybdd.demos.todos.pageobjects.features.maintain_my_todo_list.DeleteTodos", + "testSteps": [ + { + "number": 1, + "description": "Starts with a todo list containing: {Walk the dog,Put out the garbage}", + "duration": 10347, + "startTime": 1471627633044, + "screenshots": [ + { + "screenshot": "80523f16e7fa7ac324459dd886c8bb65.png" + } + ], + "result": "SUCCESS", + "children": [ + { + "number": 2, + "description": "Adds todo items called: {Walk the dog,Put out the garbage}", + "duration": 4220, + "startTime": 1471627638868, + "screenshots": [ + { + "screenshot": "03ac8c292851b7a7c7913e29f08cfeda.png" + }, + { + "screenshot": "80523f16e7fa7ac324459dd886c8bb65.png" + } + ], + "result": "SUCCESS", + "children": [ + { + "number": 3, + "description": "Adds a todo item called: Walk the dog", + "duration": 1054, + "startTime": 1471627640165, + "screenshots": [ + { + "screenshot": "6a138a61bfaeb04a2c38bde5c2f19ce5.png" + }, + { + "screenshot": "e429103b0c51362a0a26e87c7b8a19ab.png" + } + ], + "result": "SUCCESS" + }, + { + "number": 4, + "description": "Adds a todo item called: Put out the garbage", + "duration": 1165, + "startTime": 1471627641220, + "screenshots": [ + { + "screenshot": "e429103b0c51362a0a26e87c7b8a19ab.png" + }, + { + "screenshot": "80523f16e7fa7ac324459dd886c8bb65.png" + } + ], + "result": "SUCCESS" + } + ] + } + ] + }, + { + "number": 5, + "description": "Deletes: Walk the dog", + "duration": 687, + "startTime": 1471627643392, + "screenshots": [ + { + "screenshot": "c2f67cb31d341a690b336800645ad634.png" + } + ], + "result": "SUCCESS" + }, + { + "number": 6, + "description": "Should see that the number of items left is: 2", + "duration": 738, + "startTime": 1471627644080, + "screenshots": [ + { + "screenshot": "c2f67cb31d341a690b336800645ad634.png", + "htmlSource": "pagesource3393576089547360695.html.txt" + } + ], + "exception": { + "errorType": "java.lang.AssertionError", + "message": "\nExpected: is \u003c2\u003e\n but: was \u003c1\u003e", + "stackTrace": [ + { + "declaringClass": "net.serenitybdd.demos.todos.pageobjects.steps.TodoUserSteps", + "methodName": "should_see_that_the_number_of_items_left_is", + "fileName": "TodoUserSteps.java", + "lineNumber": 101 + }, + { + "declaringClass": "net.serenitybdd.demos.todos.pageobjects.features.maintain_my_todo_list.DeleteTodos", + "methodName": "should_see_deleting_a_todo_decreases_the_remaining_items_count", + "fileName": "DeleteTodos.java", + "lineNumber": 37 + } + ] + }, + "result": "FAILURE" + } + ], + "userStory": { + "id": "net.serenitybdd.demos.todos.pageobjects.features.maintain_my_todo_list.DeleteTodos", + "storyName": "Delete todos", + "storyClassName": "net.serenitybdd.demos.todos.pageobjects.features.maintain_my_todo_list.DeleteTodos", + "path": "net.serenitybdd.demos.todos.pageobjects.features.maintain_my_todo_list", + "type": "feature" + }, + "featureTag": { + "name": "Delete todos", + "type": "feature" + }, + "title": "Should see deleting a todo decreases the remaining items count", + "tags": [ + { + "name": "Delete todos", + "type": "feature" + }, + { + "name": "Assertion error", + "type": "error type" + }, + { + "name": "Maintain my todo list/Delete todos", + "type": "feature" + }, + { + "name": "Maintain my todo list", + "type": "capability" + }, + { + "name": "PageObjects pattern", + "type": "tag" + } + ], + "startTime": 1471627632706, + "duration": 12117, + "testFailureCause": { + "errorType": "java.lang.AssertionError", + "message": "\nExpected: is \u003c2\u003e\n but: was \u003c1\u003e", + "stackTrace": [ + { + "declaringClass": "net.serenitybdd.demos.todos.pageobjects.steps.TodoUserSteps", + "methodName": "should_see_that_the_number_of_items_left_is", + "fileName": "TodoUserSteps.java", + "lineNumber": 101 + }, + { + "declaringClass": "net.serenitybdd.demos.todos.pageobjects.features.maintain_my_todo_list.DeleteTodos", + "methodName": "should_see_deleting_a_todo_decreases_the_remaining_items_count", + "fileName": "DeleteTodos.java", + "lineNumber": 37 + } + ] + }, + "testFailureClassname": "java.lang.AssertionError", + "testFailureMessage": "\nExpected: is \u003c2\u003e\n but: was \u003c1\u003e", + "annotatedResult": "FAILURE", + "sessionId": "7fe4e9ea47f6d3ec3325a6875cce4fd4", + "driver": "firefox", + "manual": false, + "testSource": "JUnit", + "result": "FAILURE" +} \ No newline at end of file diff --git a/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/sample-outcome.json b/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/sample-outcome.json new file mode 100644 index 00000000000..611ead56985 --- /dev/null +++ b/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/sample-outcome.json @@ -0,0 +1,341 @@ +{ + "name": "All the taxi ranks within a given distance should be shown", + "id": "find-taxi-stands-by-proximity;all-the-taxi-ranks-within-a-given-distance-should-be-shown;;2", + "testSteps": [ + { + "number": 1, + "description": "All the taxi ranks within a given distance should be shown #1: {station\u003dLondon Bridge Station, distance\u003d500, number-of-taxis\u003d5}", + "duration": 330, + "startTime": 1487252331585, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 2, + "description": "Given Joe is at London Bridge Station", + "duration": 2, + "startTime": 1487252331586, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 3, + "description": "When he looks for the closest taxi rank within 500 meters", + "duration": 277, + "startTime": 1487252331588, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 4, + "description": "GET https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.505353\u0026lon\u003d-0.084826\u0026radius\u003d500", + "duration": 0, + "startTime": 1487252331864, + "result": "SUCCESS", + "restQuery": { + "method": "GET", + "path": "https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.505353\u0026lon\u003d-0.084826\u0026radius\u003d500", + "content": "", + "contentType": "null", + "requestHeaders": "Accept\u003d*/*", + "requestCookies": "", + "responseHeaders": "Date: Thu, 16 Feb 2017 13:38:51 GMT\nContent-Type: application/json; charset\u003dutf-8\nContent-Length: 780\nConnection: keep-alive\nSet-Cookie: __cfduid\u003dd261c04a36a605f4507bbcd6498cb17261487252331; expires\u003dFri, 16-Feb-18 13:38:51 GMT; path\u003d/; domain\u003d.tfl.gov.uk; HttpOnly\nAccess-Control-Allow-Headers: Content-Type\nAccess-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS\nAccess-Control-Allow-Origin: *\nAge: 0\nApi-Entity-Payload: Place\nCache-Control: public, must-revalidate, max-age\u003d43200, s-maxage\u003d86400\nContent-Encoding: gzip\nVia: 1.1 varnish\nX-AspNet-Version: 4.0.30319\nX-Backend: api\nX-Banning: \nX-Cache: MISS\nX-Cacheable: Yes. Cacheable\nX-TTL: 86400.000\nX-TTL-RULE: 0\nX-Varnish: 2052484925\nServer: cloudflare-nginx\nCF-RAY: 332166fe9ebd295d-DUB", + "responseCookies": "__cfduid\u003dd261c04a36a605f4507bbcd6498cb17261487252331;Path\u003d/;Domain\u003d.tfl.gov.uk;HttpOnly;Expires\u003d16/02/18 13:38", + "responseBody": "{\n \"$type\": \"Tfl.Api.Presentation.Entities.PlacesResponse, Tfl.Api.Presentation.Entities\",\n \"centrePoint\": [\n 51.505,\n -0.084\n ],\n \"places\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5471\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5471\",\n \"commonName\": \"Tooley Street (Duke Street Hill)\",\n \"distance\": 182.06776823370367,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"1\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.505751,\n \"lon\": -0.086335\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5948\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5948\",\n \"commonName\": \"London Bridge Bus Station (London Bridge Station)\",\n \"distance\": 195.79477121883437,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"20\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.505031,\n \"lon\": -0.086826\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5876\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5876\",\n \"commonName\": \"St Thomas Street\",\n \"distance\": 207.47269598420945,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"6\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.504129,\n \"lon\": -0.086648\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5578\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5578\",\n \"commonName\": \"Southwark Street (Borough High Street)\",\n \"distance\": 467.6943317720515,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.504681,\n \"lon\": -0.090732\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5915\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5915\",\n \"commonName\": \"Lower Thames Street\",\n \"distance\": 497.16677031138994,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"9\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.508388,\n \"lon\": -0.079322\n }\n ]\n}", + "statusCode": 200 + }, + "precondition": false + } + ] + }, + { + "number": 5, + "description": "Then 5 taxi ranks should be found", + "duration": 25, + "startTime": 1487252331865, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 6, + "description": "And all of the taxi ranks should be no more than 500 meters away", + "duration": 25, + "startTime": 1487252331890, + "result": "SUCCESS", + "precondition": false + } + ] + }, + { + "number": 7, + "description": "All the taxi ranks within a given distance should be shown #2: {station\u003dLondon Bridge Station, distance\u003d1000, number-of-taxis\u003d18}", + "duration": 239, + "startTime": 1487252331916, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 8, + "description": "Given Joe is at London Bridge Station", + "duration": 1, + "startTime": 1487252331917, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 9, + "description": "When he looks for the closest taxi rank within 1000 meters", + "duration": 163, + "startTime": 1487252331918, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 10, + "description": "GET https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.505353\u0026lon\u003d-0.084826\u0026radius\u003d1000", + "duration": 0, + "startTime": 1487252332080, + "result": "SUCCESS", + "restQuery": { + "method": "GET", + "path": "https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.505353\u0026lon\u003d-0.084826\u0026radius\u003d1000", + "content": "", + "contentType": "null", + "requestHeaders": "Accept\u003d*/*", + "requestCookies": "", + "responseHeaders": "Date: Thu, 16 Feb 2017 13:38:51 GMT\nContent-Type: application/json; charset\u003dutf-8\nContent-Length: 1791\nConnection: keep-alive\nSet-Cookie: __cfduid\u003ddaf0809254cd3eeb1040bd57fd2f5fbc21487252331; expires\u003dFri, 16-Feb-18 13:38:51 GMT; path\u003d/; domain\u003d.tfl.gov.uk; HttpOnly\nAccess-Control-Allow-Headers: Content-Type\nAccess-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS\nAccess-Control-Allow-Origin: *\nAge: 0\nApi-Entity-Payload: Place\nCache-Control: public, must-revalidate, max-age\u003d43200, s-maxage\u003d86400\nContent-Encoding: gzip\nVia: 1.1 varnish\nX-AspNet-Version: 4.0.30319\nX-Backend: api\nX-Banning: \nX-Cache: MISS\nX-Cacheable: Yes. Cacheable\nX-TTL: 86400.000\nX-TTL-RULE: 0\nX-Varnish: 2052485039\nServer: cloudflare-nginx\nCF-RAY: 33216700ca97297b-DUB", + "responseCookies": "__cfduid\u003ddaf0809254cd3eeb1040bd57fd2f5fbc21487252331;Path\u003d/;Domain\u003d.tfl.gov.uk;HttpOnly;Expires\u003d16/02/18 13:38", + "responseBody": "{\n \"$type\": \"Tfl.Api.Presentation.Entities.PlacesResponse, Tfl.Api.Presentation.Entities\",\n \"centrePoint\": [\n 51.505,\n -0.084\n ],\n \"places\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5471\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5471\",\n \"commonName\": \"Tooley Street (Duke Street Hill)\",\n \"distance\": 182.06776823370367,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"1\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5471\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.505751,\n \"lon\": -0.086335\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5948\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5948\",\n \"commonName\": \"London Bridge Bus Station (London Bridge Station)\",\n \"distance\": 195.79477121883437,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"20\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5948\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.505031,\n \"lon\": -0.086826\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5876\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5876\",\n \"commonName\": \"St Thomas Street\",\n \"distance\": 207.47269598420945,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"6\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5876\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.504129,\n \"lon\": -0.086648\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5578\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5578\",\n \"commonName\": \"Southwark Street (Borough High Street)\",\n \"distance\": 467.6943317720515,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5578\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.504681,\n \"lon\": -0.090732\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5915\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5915\",\n \"commonName\": \"Lower Thames Street\",\n \"distance\": 497.16677031138994,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"9\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5915\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.508388,\n \"lon\": -0.079322\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5916\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5916\",\n \"commonName\": \"Mincing Lane\",\n \"distance\": 677.43261701910751,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5916\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5916\",\n \"value\": \"4\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5916\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5916\",\n \"value\": \"10.00 - 06.00\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5916\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.510879,\n \"lon\": -0.081465\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5502\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5502\",\n \"commonName\": \"Southwark Street (O\u0027Meara Street)\",\n \"distance\": 726.269885908667,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5502\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5502\",\n \"value\": \"1\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5502\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5502\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5502\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.504742,\n \"lon\": -0.094476\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5919\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5919\",\n \"commonName\": \"Philpot Lane\",\n \"distance\": 728.75617066874167,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5919\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5919\",\n \"value\": \"4\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5919\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5919\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5919\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.511548,\n \"lon\": -0.083916\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5941\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5941\",\n \"commonName\": \"DoubleTree Hotel, Tower of London, hotel forecourt\",\n \"distance\": 765.87517853207726,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5941\",\n \"value\": \"Newham\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5941\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5941\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5941\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5941\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.510824,\n \"lon\": -0.07811\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5269\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5269\",\n \"commonName\": \"Trinity Square (Tower Hill Station)\",\n \"distance\": 798.71093163009778,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5269\",\n \"value\": \"Tower Hamlets\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5269\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5269\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5269\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5269\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"StationAtcoCode\",\n \"sourceSystemKey\": \"5269\",\n \"value\": \"940GZZLUTWH\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.510651,\n \"lon\": -0.076892\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5900\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5900\",\n \"commonName\": \"Cooper\u0027s Row\",\n \"distance\": 807.71999407643568,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5900\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5900\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5900\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5900\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5900\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.510805,\n \"lon\": -0.077001\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5905\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5905\",\n \"commonName\": \"Fenchurch Street, station forecourt (Fenchurch Street Station)\",\n \"distance\": 836.10029872424968,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5905\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5905\",\n \"value\": \"4\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5905\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5905\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5905\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.511894,\n \"lon\": -0.079203\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5451\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5451\",\n \"commonName\": \"East Smithfield (Royal Mint Court)\",\n \"distance\": 868.12287109445435,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5451\",\n \"value\": \"Tower Hamlets\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5451\",\n \"value\": \"3\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5451\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5451\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5451\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.509017,\n \"lon\": -0.073257\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5917\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5917\",\n \"commonName\": \"Minories\",\n \"distance\": 883.36899671922572,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5917\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5917\",\n \"value\": \"3\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5917\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5917\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5917\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.510583,\n \"lon\": -0.074935\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5902\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5902\",\n \"commonName\": \"Crosswall\",\n \"distance\": 898.12511606547093,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5902\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5902\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5902\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5902\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5902\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.511542,\n \"lon\": -0.076408\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5415\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5415\",\n \"commonName\": \"New Globe Walk (Globe Theatre)\",\n \"distance\": 917.87997541557081,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5415\",\n \"value\": \"Southwark\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5415\",\n \"value\": \"3\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5415\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5415\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5415\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.507796,\n \"lon\": -0.096466\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5901\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5901\",\n \"commonName\": \"Cornhill\",\n \"distance\": 944.09661157945982,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5901\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5901\",\n \"value\": \"4\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5901\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5901\",\n \"value\": \"19.00 - 07.00\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5901\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.513312,\n \"lon\": -0.086724\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5910\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5910\",\n \"commonName\": \"Leadenhall Street\",\n \"distance\": 950.04212696622221,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5910\",\n \"value\": \"City of London\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5910\",\n \"value\": \"2\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5910\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5910\",\n \"value\": \"19:00 - 07:00\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5910\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.513497,\n \"lon\": -0.082681\n }\n ]\n}", + "statusCode": 200 + }, + "precondition": false + } + ] + }, + { + "number": 11, + "description": "Then 18 taxi ranks should be found", + "duration": 41, + "startTime": 1487252332081, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 12, + "description": "And all of the taxi ranks should be no more than 1000 meters away", + "duration": 32, + "startTime": 1487252332123, + "result": "SUCCESS", + "precondition": false + } + ] + }, + { + "number": 13, + "description": "All the taxi ranks within a given distance should be shown #3: {station\u003dCanary Wharf, distance\u003d100, number-of-taxis\u003d3}", + "duration": 203, + "startTime": 1487252332156, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 14, + "description": "Given Joe is at Canary Wharf", + "duration": 2, + "startTime": 1487252332157, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 15, + "description": "When he looks for the closest taxi rank within 100 meters", + "duration": 180, + "startTime": 1487252332159, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 16, + "description": "GET https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.50362\u0026lon\u003d-0.01987\u0026radius\u003d100", + "duration": 0, + "startTime": 1487252332339, + "result": "SUCCESS", + "restQuery": { + "method": "GET", + "path": "https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.50362\u0026lon\u003d-0.01987\u0026radius\u003d100", + "content": "", + "contentType": "null", + "requestHeaders": "Accept\u003d*/*", + "requestCookies": "", + "responseHeaders": "Date: Thu, 16 Feb 2017 13:38:51 GMT\nContent-Type: application/json; charset\u003dutf-8\nContent-Length: 562\nConnection: keep-alive\nSet-Cookie: __cfduid\u003dd261c04a36a605f4507bbcd6498cb17261487252331; expires\u003dFri, 16-Feb-18 13:38:51 GMT; path\u003d/; domain\u003d.tfl.gov.uk; HttpOnly\nAccess-Control-Allow-Headers: Content-Type\nAccess-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS\nAccess-Control-Allow-Origin: *\nAge: 0\nApi-Entity-Payload: Place\nCache-Control: public, must-revalidate, max-age\u003d43200, s-maxage\u003d86400\nContent-Encoding: gzip\nVia: 1.1 varnish\nX-AspNet-Version: 4.0.30319\nX-Backend: api\nX-Banning: \nX-Cache: MISS\nX-Cacheable: Yes. Cacheable\nX-TTL: 86400.000\nX-TTL-RULE: 0\nX-Varnish: 2052485103\nServer: cloudflare-nginx\nCF-RAY: 3321670248b4295d-DUB", + "responseCookies": "__cfduid\u003dd261c04a36a605f4507bbcd6498cb17261487252331;Path\u003d/;Domain\u003d.tfl.gov.uk;HttpOnly;Expires\u003d16/02/18 13:38", + "responseBody": "{\n \"$type\": \"Tfl.Api.Presentation.Entities.PlacesResponse, Tfl.Api.Presentation.Entities\",\n \"centrePoint\": [\n 51.503,\n -0.019\n ],\n \"places\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5955\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5955\",\n \"commonName\": \"40 Bank Street\",\n \"distance\": 34.576972429751351,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5955\",\n \"value\": \"Tower Hamlets\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5955\",\n \"value\": \"1\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5955\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5955\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5955\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.502759,\n \"lon\": -0.019315\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5958\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5958\",\n \"commonName\": \"Bank Street\",\n \"distance\": 75.443106819016322,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5958\",\n \"value\": \"Tower Hamlets\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5958\",\n \"value\": \"4\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5958\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5958\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5958\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.502622,\n \"lon\": -0.018096\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.Place, Tfl.Api.Presentation.Entities\",\n \"id\": \"TaxiRank_5957\",\n \"url\": \"https://api-radon.tfl.gov.uk/Place/TaxiRank_5957\",\n \"commonName\": \"50 Bank Street\",\n \"distance\": 77.6346264024308,\n \"placeType\": \"TaxiRank\",\n \"additionalProperties\": [\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Address\",\n \"key\": \"Borough\",\n \"sourceSystemKey\": \"5957\",\n \"value\": \"Tower Hamlets\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"NumberOfSpaces\",\n \"sourceSystemKey\": \"5957\",\n \"value\": \"10\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationDays\",\n \"sourceSystemKey\": \"5957\",\n \"value\": \"Mon - Sun\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"OperationTimes\",\n \"sourceSystemKey\": \"5957\",\n \"value\": \"24 hours\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n },\n {\n \"$type\": \"Tfl.Api.Presentation.Entities.AdditionalProperties, Tfl.Api.Presentation.Entities\",\n \"category\": \"Description\",\n \"key\": \"RankType\",\n \"sourceSystemKey\": \"5957\",\n \"value\": \"Working\",\n \"modified\": \"2017-02-13T14:20:59.16Z\"\n }\n ],\n \"childrenUrls\": [\n \n ],\n \"lat\": 51.502763,\n \"lon\": -0.017946\n }\n ]\n}", + "statusCode": 200 + }, + "precondition": false + } + ] + }, + { + "number": 17, + "description": "Then 3 taxi ranks should be found", + "duration": 11, + "startTime": 1487252332339, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 18, + "description": "And all of the taxi ranks should be no more than 100 meters away", + "duration": 9, + "startTime": 1487252332350, + "result": "SUCCESS", + "precondition": false + } + ] + }, + { + "number": 19, + "description": "All the taxi ranks within a given distance should be shown #4: {station\u003dCanary Wharf, distance\u003d20, number-of-taxis\u003d0}", + "duration": 105, + "startTime": 1487252332359, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 20, + "description": "Given Joe is at Canary Wharf", + "duration": 1, + "startTime": 1487252332360, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 21, + "description": "When he looks for the closest taxi rank within 20 meters", + "duration": 88, + "startTime": 1487252332361, + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 22, + "description": "GET https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.50362\u0026lon\u003d-0.01987\u0026radius\u003d20", + "duration": 0, + "startTime": 1487252332449, + "result": "SUCCESS", + "restQuery": { + "method": "GET", + "path": "https://api.tfl.gov.uk/Place?type\u003dTaxiRank\u0026app_id\u003ddc9b9904\u0026app_key\u003da250730b80c5fb5f0dc0dc0e44a5abfa\u0026lat\u003d51.50362\u0026lon\u003d-0.01987\u0026radius\u003d20", + "content": "", + "contentType": "null", + "requestHeaders": "Accept\u003d*/*", + "requestCookies": "", + "responseHeaders": "Date: Thu, 16 Feb 2017 13:38:52 GMT\nContent-Type: application/json; charset\u003dutf-8\nContent-Length: 116\nConnection: keep-alive\nSet-Cookie: __cfduid\u003dd5bf9275210bb01522a8297587bac3ac21487252332; expires\u003dFri, 16-Feb-18 13:38:52 GMT; path\u003d/; domain\u003d.tfl.gov.uk; HttpOnly\nAccess-Control-Allow-Headers: Content-Type\nAccess-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS\nAccess-Control-Allow-Origin: *\nAge: 0\nApi-Entity-Payload: Place\nCache-Control: public, must-revalidate, max-age\u003d43200, s-maxage\u003d86400\nContent-Encoding: gzip\nVia: 1.1 varnish\nX-AspNet-Version: 4.0.30319\nX-Backend: api\nX-Banning: \nX-Cache: MISS\nX-Cacheable: Yes. Cacheable\nX-TTL: 86400.000\nX-TTL-RULE: 0\nX-Varnish: 1346243944\nServer: cloudflare-nginx\nCF-RAY: 332167036c1a299f-DUB", + "responseCookies": "__cfduid\u003dd5bf9275210bb01522a8297587bac3ac21487252332;Path\u003d/;Domain\u003d.tfl.gov.uk;HttpOnly;Expires\u003d16/02/18 13:38", + "responseBody": "{\n \"$type\": \"Tfl.Api.Presentation.Entities.PlacesResponse, Tfl.Api.Presentation.Entities\",\n \"centrePoint\": [\n 51.503,\n -0.019\n ],\n \"places\": [\n \n ]\n}", + "statusCode": 200 + }, + "precondition": false + } + ] + }, + { + "number": 23, + "description": "Then 0 taxi ranks should be found", + "duration": 7, + "startTime": 1487252332449, + "result": "SUCCESS", + "precondition": false + }, + { + "number": 24, + "description": "And all of the taxi ranks should be no more than 20 meters away", + "duration": 8, + "startTime": 1487252332456, + "result": "SUCCESS", + "precondition": false + } + ] + } + ], + "userStory": { + "id": "find-taxi-stands-by-proximity", + "storyName": "Find taxi stands by proximity", + "path": "find_taxi_stands_by_proximity.feature", + "narrative": "In order to get home alive\nAs an inebriated business man\nI want to find the taxi stand nearest to my current location", + "type": "feature" + }, + "featureTag": { + "name": "Find taxi stands by proximity", + "type": "feature" + }, + "title": "All the taxi ranks within a given distance should be shown", + "description": "", + "tags": [ + { + "name": "Find taxi ranks", + "type": "capability" + }, + { + "name": "Find taxi ranks/Find taxi stands by proximity", + "type": "feature" + } + ], + "startTime": 1487252331584, + "duration": 880, + "projectKey": "", + "dataTable": { + "headers": [ + "station", + "distance", + "number-of-taxis" + ], + "rows": [ + { + "values": [ + "London Bridge Station", + "500", + "5" + ], + "result": "SUCCESS" + }, + { + "values": [ + "London Bridge Station", + "1000", + "18" + ], + "result": "SUCCESS" + }, + { + "values": [ + "Canary Wharf", + "100", + "3" + ], + "result": "SUCCESS" + }, + { + "values": [ + "Canary Wharf", + "20", + "0" + ], + "result": "SUCCESS" + } + ], + "predefinedRows": true, + "dataSetDescriptors": [ + { + "startRow": 0, + "rowCount": 0, + "name": "", + "description": "" + } + ] + }, + "manual": false, + "testSource": "Cucumber", + "result": "SUCCESS" +} \ No newline at end of file diff --git a/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/sample-with-screenshots.json b/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/sample-with-screenshots.json new file mode 100644 index 00000000000..05844c0948a --- /dev/null +++ b/packages/core/spec/stage/crew/serenity-bdd-reporter/example-reports/sample-with-screenshots.json @@ -0,0 +1,437 @@ +{ + "name": "visualising_a_failing_project", + "id": "features.ProjectStatusShouldBeEasyToDetermine:visualising_a_failing_project", + "testCaseName": "features.ProjectStatusShouldBeEasyToDetermine", + "testSteps": [ + { + "number": 1, + "description": "Anna creates the \u0027My App\u0027 project and schedules a build that fails", + "duration": 17403, + "startTime": "2018-05-07T15:30:04.650+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "3153063ead120ec113a3974b53dafa5bd9f4e42bdb04611959c92b815e7ec498.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 2, + "description": "Anna creates the \u0027My App\u0027 project", + "duration": 15695, + "startTime": "2018-05-07T15:30:04.658+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "4fb987955bb65562d24a49e48e839370e260c343f628ea2cc5b78f0e607d6b65.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 3, + "description": "Anna creates a \u0027Freestyle Project\u0027 called \u0027My App\u0027", + "duration": 14217, + "startTime": "2018-05-07T15:30:04.665+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "f121b74fd1f0d8ad9089e470504df4d744d5ff8b4cbc6af9339834c9e2e08377.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 4, + "description": "Anna creates a \u0027Freestyle Project\u0027 called \u0027My App\u0027", + "duration": 13572, + "startTime": "2018-05-07T15:30:04.673+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "f121b74fd1f0d8ad9089e470504df4d744d5ff8b4cbc6af9339834c9e2e08377.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 5, + "description": "Anna clicks on the \u0027New Item\u0027 link", + "duration": 1682, + "startTime": "2018-05-07T15:30:04.693+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "f436b679440e0551eddfa638c9cff8237f8059ed29e45f8787b335fa75b426cd.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 6, + "description": "Anna enters \u0027My App\u0027 into Item name", + "duration": 843, + "startTime": "2018-05-07T15:30:06.377+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "5cf3900d3d5c750691a92daeced581c1174a5533fb1446f0b8fe3d760d48c4ed.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 7, + "description": "Anna clicks on Freestyle project", + "duration": 876, + "startTime": "2018-05-07T15:30:07.223+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "41af76b0d7f2e2cc89c44a74c5bf71a74248f9819f3cddbddbe57f26dbecfc7e.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 8, + "description": "Anna clicks on the \u0027OK\u0027 button", + "duration": 4855, + "startTime": "2018-05-07T15:30:08.137+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "459a7e48fad021761dfbc8fda4bd26c313bd0e55b4255dfb89eb504b90bd77b0.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 9, + "description": "Anna configures the Shell Step to execute a script that \u0027Finishes with error\u0027", + "duration": 3315, + "startTime": "2018-05-07T15:30:12.993+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "93f6b2791e7e7131030e36a2ee836a88b67e3aae6bcd94948644fb2bcb48e198.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 10, + "description": "Anna clicks on the \u0027Add build step\u0027 button", + "duration": 716, + "startTime": "2018-05-07T15:30:13.044+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "3033ec3e854577089d200dba9805968cfcfe8926c4f10e6645c16317cd321437.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 11, + "description": "Anna clicks on the \u0027Execute shell\u0027 link", + "duration": 685, + "startTime": "2018-05-07T15:30:13.761+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "164df89e134726a2bee5a36210fb6bce136a7beeb57e372e4904169849a52db2.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 12, + "description": "Anna enters \u0027exit 1;\u0027 into the code editor field", + "duration": 1336, + "startTime": "2018-05-07T15:30:14.448+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "7e9a359648a3537b4385f71ca681ead0ec3902380b67bb3ceedaa9a53bfe41a4.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 13, + "description": "Anna clicks on code editor", + "duration": 752, + "startTime": "2018-05-07T15:30:14.462+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "6f6992f3d491ac599ce206e2d8862323cdb1e824569d4d7fe2f3c2204b00ba44.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ] + } + ] + }, + { + "number": 14, + "description": "Anna clicks on the \u0027Save\u0027 button", + "duration": 1330, + "startTime": "2018-05-07T15:30:16.310+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "f121b74fd1f0d8ad9089e470504df4d744d5ff8b4cbc6af9339834c9e2e08377.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ] + } + ] + }, + { + "number": 15, + "description": "Anna clicks on Back to Dashboard", + "duration": 986, + "startTime": "2018-05-07T15:30:18.883+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "4fb987955bb65562d24a49e48e839370e260c343f628ea2cc5b78f0e607d6b65.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ] + }, + { + "number": 16, + "description": "Anna schedules a build of the \u0027My App\u0027 project ", + "duration": 1205, + "startTime": "2018-05-07T15:30:20.354+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "3153063ead120ec113a3974b53dafa5bd9f4e42bdb04611959c92b815e7ec498.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 17, + "description": "Anna clicks on the \u0027build now\u0027 link", + "duration": 696, + "startTime": "2018-05-07T15:30:20.356+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "081737650a65cac19bef4de32368ac28b6258b4971ccd00f1de43d90d8372c7e.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ] + } + ] + }, + { + "number": 18, + "description": "Anna creates a \u0027Build Monitor View\u0027 showing all the projects", + "duration": 9631, + "startTime": "2018-05-07T15:30:22.068+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "1e70535e2b193923ac2d2e19a2aaaa3fe86cb5dec04f6718548e37024318bd31.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 19, + "description": "Anna creates a \u0027Build Monitor View\u0027 called \u0027Build Monitor\u0027", + "duration": 9018, + "startTime": "2018-05-07T15:30:22.072+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "1e70535e2b193923ac2d2e19a2aaaa3fe86cb5dec04f6718548e37024318bd31.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 20, + "description": "Anna clicks on the \u0027+\u0027 link", + "duration": 948, + "startTime": "2018-05-07T15:30:22.078+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "761b4beee0a3d75bdff7da67d64052a875be07d0789b2deee40ecaa6c1b2c4e2.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 21, + "description": "Anna enters \u0027Build Monitor\u0027 into View name", + "duration": 731, + "startTime": "2018-05-07T15:30:23.028+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "6ffe7739d7e46e6385625b53283ee416c31653e81cf1b060a719565300bee9e2.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 22, + "description": "Anna clicks on the \u0027Build Monitor View\u0027 radio button", + "duration": 647, + "startTime": "2018-05-07T15:30:23.760+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "a74a4c601ac6b33ecbf9656e55d45f3f56af2bf071a2a8ebf176fc0a03493d11.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 23, + "description": "Anna clicks on the \u0027OK\u0027 button", + "duration": 981, + "startTime": "2018-05-07T15:30:24.408+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "5e22e8d2c048d155d598392a0d170ef95182500761050677d6b4ccf10a0635f4.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 24, + "description": "Anna uses a regular expression to display all projects", + "duration": 2342, + "startTime": "2018-05-07T15:30:25.391+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "3dcbf01ae6480db0cee978189880dbb51c47a994ad20dc50eefba2f232333c65.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 25, + "description": "Anna clicks on the \u0027Use a regular expression to include jobs into the view\u0027 checkbox", + "duration": 952, + "startTime": "2018-05-07T15:30:25.398+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "0be9c24f6039a38597856a903761493cd4d7f5946fad888ecc6019fcba51da44.png" + } + ], + "result": "SUCCESS", + "precondition": false + }, + { + "number": 26, + "description": "Anna enters \u0027.*\u0027 into the \u0027Regular expression\u0027 field", + "duration": 817, + "startTime": "2018-05-07T15:30:26.352+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "1f3e478b1f70dd5a68216efe796f9690dc538598f209202a27d7b6d4b762a825.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ] + }, + { + "number": 27, + "description": "Anna saves the changes and leaves the configuration screen", + "duration": 2819, + "startTime": "2018-05-07T15:30:27.735+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "1e70535e2b193923ac2d2e19a2aaaa3fe86cb5dec04f6718548e37024318bd31.png" + } + ], + "result": "SUCCESS", + "precondition": false, + "children": [ + { + "number": 28, + "description": "Anna clicks on the \u0027OK\u0027 button", + "duration": 2254, + "startTime": "2018-05-07T15:30:27.737+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "1e70535e2b193923ac2d2e19a2aaaa3fe86cb5dec04f6718548e37024318bd31.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ] + } + ] + } + ] + }, + { + "number": 29, + "description": "Then the widget representing the \u0027My App\u0027 project on the Build Monitor should be displaying the status as \u0027failing\u0027", + "duration": 572, + "startTime": "2018-05-07T15:30:31.700+01:00[Europe/London]", + "screenshots": [ + { + "screenshot": "1e70535e2b193923ac2d2e19a2aaaa3fe86cb5dec04f6718548e37024318bd31.png" + } + ], + "result": "SUCCESS", + "precondition": false + } + ], + "userStory": { + "id": "features.ProjectStatusShouldBeEasyToDetermine", + "storyName": "Project status should be easy to determine", + "storyClassName": "features.ProjectStatusShouldBeEasyToDetermine", + "path": "", + "type": "story" + }, + "featureTag": { + "name": "Project status should be easy to determine", + "type": "story" + }, + "title": "Visualising a failing project", + "tags": [ + { + "name": "Project status should be easy to determine", + "type": "story" + }, + { + "name": "jenkins-2.46.3", + "type": "context" + } + ], + "startTime": "2018-05-07T15:29:50.103+01:00[Europe/London]", + "duration": 42169, + "projectKey": "", + "sessionId": "940dfbd74317c0f9287203c19ee62b58", + "driver": "chrome:--lang\u003den", + "context": "jenkins-2.46.3", + "manual": false, + "testSource": "JUnit", + "result": "SUCCESS" +} \ No newline at end of file diff --git a/packages/core/spec/stage/stage.spec.ts b/packages/core/spec/stage/stage.spec.ts deleted file mode 100644 index 0a9b8b4d532..00000000000 --- a/packages/core/spec/stage/stage.spec.ts +++ /dev/null @@ -1,74 +0,0 @@ -import { Serenity } from '../../src'; -import { Actor } from '../../src/screenplay'; -import { Cast, Stage, StageManager } from '../../src/stage'; - -import sinon = require('sinon'); - -import expect = require('../expect'); - -describe ('The Stage', () => { - - class MyActors implements Cast { - actor = (name: string): Actor => Actor.named(name); - } - - describe ('when used in an acceptance test', () => { - it ('can be instantiated from Serenity', () => { - const - stage = new Serenity().callToStageFor(new MyActors()), - - james = stage.theActorCalled('James'); - - expect(james.toString()).to.equal('James'); - - expect(stage.theActorInTheSpotlight()).to.equal(james); - }); - - it ('can tell if there is no Actor in the spotlight yet', () => { - const - stageManager: StageManager = sinon.createStubInstance(StageManager) as any, - - stage = new Stage(stageManager); - - stage.enter(new MyActors()); - - expect(stage.theShowHasStarted()).to.be.false; - }); - - it ('can tell if there is an Actor in the spotlight already', () => { - const - stageManager: StageManager = sinon.createStubInstance(StageManager) as any, - - stage = new Stage(stageManager); - - stage.enter(new MyActors()); - - stage.theActorCalled('James'); - - expect(stage.theShowHasStarted()).to.be.true; - }); - }); - - describe ('when used incorrectly', () => { - - it ('complains if you try to call an Actor, but have not yet provided the Cast yet', () => { - const - stageManager: StageManager = sinon.createStubInstance(StageManager) as any, - - stage = new Stage(stageManager); - - expect(() => stage.theActorCalled('James')).to.throw('The cast has not entered the stage yet.'); - }); - - it ('complains if you try to get the Actor in the spotlight, but have not shined the spotlight on anyone yet', () => { - const - stageManager: StageManager = sinon.createStubInstance(StageManager) as any, - - stage = new Stage(stageManager); - - stage.enter(new MyActors()); - - expect(() => stage.theActorInTheSpotlight()).to.throw('There\'s no actor in the spotlight yet.'); - }); - }); -}); diff --git a/packages/core/spec/stage/stage_manager.spec.ts b/packages/core/spec/stage/stage_manager.spec.ts deleted file mode 100644 index f729ce41059..00000000000 --- a/packages/core/spec/stage/stage_manager.spec.ts +++ /dev/null @@ -1,319 +0,0 @@ -import { DomainEvent } from '../../src/domain/events'; -import { Journal, Stage, StageCrewMember, StageManager } from '../../src/stage'; -import sinon = require('sinon'); - -import expect = require('../expect'); - -describe('Recording what happened during the test', () => { - - describe('The Stage Manager', () => { - const now = 1467395872000; - - let chronicle: Journal; - - beforeEach(() => { chronicle = new Journal(); }); - - describe('Reading the Journal', () => { - it('provides a record of what happened', () => { - - const event = new DomainEvent('You would not believe what just happened!'); - - chronicle.record(event); - - expect(chronicle.read()).to.deep.equal([event]); - }); - - it('always provides the full record of what happened, no matter how many times it is called', () => { - const - A = new DomainEvent('A', now - 3), - B = new DomainEvent('B', now - 2), - C = new DomainEvent('C', now - 1); - - chronicle.record(A); - chronicle.record(B); - chronicle.record(C); - - expect(chronicle.read()).to.deep.equal([A, B, C]); - expect(chronicle.read()).to.deep.equal([A, B, C]); - }); - - it('provides a chronological record of what happened', () => { - const - A = new DomainEvent('A', now - 3), - B = new DomainEvent('B', now - 2), - C = new DomainEvent('C', now - 1); - - chronicle.record(A); - chronicle.record(B); - chronicle.record(C); - - expect(chronicle.read()).to.deep.equal([ - A, B, C, - ]); - }); - - it('guarantees the chronological read order, even defer the write order was not chronological', () => { - const - A = new DomainEvent('A', now - 3), - B = new DomainEvent('B', now - 2), - C = new DomainEvent('C', now - 1); - - chronicle.record(C); - chronicle.record(B); - chronicle.record(A); - - expect(chronicle.read()).to.deep.equal([ - A, B, C, - ]); - }); - - it('maintains the write order of the events, if they occurred at the exact same time', () => { - const - A = new DomainEvent('A', now), - B = new DomainEvent('B', now), - C = new DomainEvent('C', now); - - chronicle.record(A); - chronicle.record(C); - chronicle.record(B); - - expect(chronicle.read()).to.deep.equal([ - A, C, B, - ]); - }); - - it('maintains the write order of the events, if some of them arrived to the party', () => { - const - A = new DomainEvent('A', now - 3), - B = new DomainEvent('B', now - 2), - C = new DomainEvent('C', now - 1), - - B1 = new DomainEvent('C', now - 2), - A1 = new DomainEvent('C', now - 3); - - chronicle.record(A); - chronicle.record(B); - chronicle.record(C); - chronicle.record(B1); - chronicle.record(A1); - - expect(chronicle.read()).to.deep.equal([ - A, A1, B, B1, C, - ]); - }); - - }); - - describe('Buffered reading', () => { - it('provides a full record of past events', () => { - const - A = new DomainEvent('A', now - 3), - B = new DomainEvent('B', now - 2), - C = new DomainEvent('C', now - 1); - - chronicle.record(A); - chronicle.record(B); - chronicle.record(C); - - expect(chronicle.read()).to.deep.equal(chronicle.readAs('some reader')); - }); - - it('allows the reader to read from where they have left', () => { - - const - id = 'unique identifier of the reader', - A = new DomainEvent('A', now - 5), - B = new DomainEvent('B', now - 4), - C = new DomainEvent('C', now - 3), - D = new DomainEvent('D', now - 2), - E = new DomainEvent('E', now - 1); - - chronicle.record(A); - chronicle.record(B); - chronicle.record(C); - - expect(chronicle.readAs(id)).to.deep.equal([A, B, C]); - - chronicle.record(D); - chronicle.record(E); - - expect(chronicle.readAs(id)).to.deep.equal([D, E]); - }); - - it('allows multiple readers to read from where they have left', () => { - - const - reader1 = 'unique identifier of the first reader', - reader2 = 'unique identifier of the second reader', - A = new DomainEvent('A', now - 5), - B = new DomainEvent('B', now - 4), - C = new DomainEvent('C', now - 3), - D = new DomainEvent('D', now - 2), - E = new DomainEvent('E', now - 1); - - chronicle.record(A); - chronicle.record(B); - - expect(chronicle.readAs(reader1)).to.deep.equal([A, B]); - - chronicle.record(C); - chronicle.record(D); - - expect(chronicle.readAs(reader2)).to.deep.equal([A, B, C, D]); - - chronicle.record(E); - - expect(chronicle.readAs(reader1)).to.deep.equal([C, D, E]); - expect(chronicle.readAs(reader2)).to.deep.equal([E]); - }); - }); - - describe('Altering the records', () => { - - it('contents cannot be altered', () => { - chronicle.record(new DomainEvent('You would not believe what just happened!')); - - chronicle.read()[0].value = 'Oh yes I would!'; - - expect(chronicle.read()[0].value).to.equal('You would not believe what just happened!'); - }); - - it('contents cannot be deleted', () => { - chronicle.record(new DomainEvent('You would not believe what just happened!')); - - delete chronicle.read()[0]; - - expect(chronicle.read()).to.have.length(1); - }); - }); - }); - - describe('The Stage Manager', () => { - - describe('Journal Maintenance', () => { - it('maintains a Journal of what happened during the test', () => { - - const - chronicle = sinon.createStubInstance(Journal) as any, - manager = new StageManager(chronicle), - event = new DomainEvent('A'); - - manager.notifyOf(event); - - expect(chronicle.record).to.have.been.calledWith(event); - }); - - it('provides means to access the contents of the chronicle', () => { - - const - chronicle = sinon.createStubInstance(Journal) as any, - manager = new StageManager(chronicle); - - manager.readTheJournal(); - expect(chronicle.read).to.have.been.called; - - manager.readNewJournalEntriesAs('some reader'); - expect(chronicle.readAs).to.have.been.calledWith('some reader'); - }); - }); - - // todo: extract into the 'stage' package - describe('Notifications', () => { - it('will notify you defer something of interest happens', () => { - const - chronicle = sinon.createStubInstance(Journal) as any, - manager = new StageManager(chronicle), - event = new DomainEvent('A'), - spy = sinon.createStubInstance(StageSpy) as any; - - manager.registerInterestIn([DomainEvent], spy); - - manager.notifyOf(event); - - expect(spy.notifyOf).to.have.been.calledWith(event); - }); - - it('will only notify the listeners interested in a specific type of an event', () => { - - class DomainEventA extends DomainEvent {} - class DomainEventB extends DomainEvent {} - class DomainEventC extends DomainEvent {} - - const - chronicle = new Journal(), - manager = new StageManager(chronicle), - A = new DomainEventA('A'), - B = new DomainEventB('B'), - spyA = sinon.createStubInstance(StageSpy) as any, - spyB = sinon.createStubInstance(StageSpy) as any, - spyC = sinon.createStubInstance(StageSpy) as any; - - manager.registerInterestIn([DomainEventA], spyA); - manager.registerInterestIn([DomainEventB], spyB); - manager.registerInterestIn([DomainEventC], spyC); - - manager.notifyOf(A); - manager.notifyOf(B); - - expect(spyA.notifyOf).to.have.been.calledWith(A); - expect(spyA.notifyOf).to.not.have.been.calledWith(B); - - expect(spyB.notifyOf).to.have.been.calledWith(B); - expect(spyB.notifyOf).to.not.have.been.calledWith(A); - - expect(spyC.notifyOf).to.not.have.been.called; - }); - - it('will notify the "catch-all" listeners, listening an all DomainEvents', () => { - - class DomainEventA extends DomainEvent {} - - const - chronicle = new Journal(), - manager = new StageManager(chronicle), - A = new DomainEventA('A'), - spyDE = sinon.createStubInstance(StageSpy) as any; - - manager.registerInterestIn([DomainEvent], spyDE); - - manager.notifyOf(A); - - expect(spyDE.notifyOf).to.have.been.calledWith(A); - }); - - it('does not allow the listener to alter the event it received', () => { - const - chronicle = new Journal(), - manager = new StageManager(chronicle), - event = new DomainEvent('original'), - noughty = new StageHacker(); - - manager.registerInterestIn([DomainEvent], noughty); - - manager.notifyOf(event); - - expect(manager.readTheJournal().pop().value).to.deep.equal('original'); - }); - - class StageSpy implements StageCrewMember { - assignTo(stageManager: Stage) { - return null; - } - - notifyOf(event: DomainEvent): void { - return null; - } - } - - class StageHacker implements StageCrewMember { - assignTo(stageManager: Stage) { - return null; - } - - notifyOf(event: DomainEvent): void { - event.value = 'modified'; - } - } - }); - }); -}); diff --git a/packages/core/spec/tasks/check.spec.ts b/packages/core/spec/tasks/check.spec.ts deleted file mode 100644 index d09f8b7cf49..00000000000 --- a/packages/core/spec/tasks/check.spec.ts +++ /dev/null @@ -1,47 +0,0 @@ -import 'mocha'; -import { given } from 'mocha-testdata'; -import * as sinon from 'sinon'; - -import { Actor, Check, Interaction, Question } from '../../src/screenplay'; -import expect = require('../expect'); - -describe('Check', () => { - - const Nick = Actor.named('Nick'); - - const Call = (fn: () => void) => Interaction.where(`#actor triggers a function`, actor => { - return Promise.resolve(fn()); - }); - - const QuestionReturning = (v: T) => Question.about(`testing`, actor => v); - - const expectYays = (spy: sinon.SinonSpy) => expect(spy).to.have.been.calledWith('Yay!').callCount(3); - const expectNoes = (spy: sinon.SinonSpy) => expect(spy).to.have.been.calledWith('Oh noes!').callCount(2); - - const examples: Array<{ 0: boolean | Question | Question>, 1: any }> = [ - [ true, expectYays ], - [ false, expectNoes ], - [ QuestionReturning(true), expectYays ], - [ QuestionReturning(false), expectNoes ], - [ QuestionReturning(Promise.resolve(true)), expectYays ], - [ QuestionReturning(Promise.resolve(false)), expectNoes ], - ]; - - given(examples).it(`triggers activities in the appropriate branch depending on the condition`, (condition, expectation) => { - - const spy = sinon.spy(); - - return expect(Nick.attemptsTo( - Check.whether(condition) - .andIfSo( - Call(() => spy(`Yay!`)), - Call(() => spy(`Yay!`)), - Call(() => spy(`Yay!`)), - ) - .otherwise( - Call(() => spy(`Oh noes!`)), - Call(() => spy(`Oh noes!`)), - ), - )).to.be.eventually.fulfilled.then(() => expectation(spy)); - }); -}); diff --git a/packages/core/src/Serenity.ts b/packages/core/src/Serenity.ts new file mode 100644 index 00000000000..be63eec5787 --- /dev/null +++ b/packages/core/src/Serenity.ts @@ -0,0 +1,6 @@ +import { StageManager } from './stage'; + +export class Serenity { + constructor(public readonly stageManager: StageManager) { + } +} diff --git a/packages/core/src/config.ts b/packages/core/src/config.ts deleted file mode 100644 index a8c13bd4d25..00000000000 --- a/packages/core/src/config.ts +++ /dev/null @@ -1,30 +0,0 @@ -import _ = require('lodash'); - -export class Config { - constructor(private config: T) { - } - - get get(): T { - return _.cloneDeep(this.config); - } - - mergedWith(otherConfig: T): Config { - return new Config(_.mergeWith({}, this.config, otherConfig, this.mergeValuesAndConcatenateLists)); - } - - withFallback(defaults: T): Config { - return new Config(_.mergeWith({}, defaults, this.config, this.mergeValuesButOverrideLists)); - } - - private mergeValuesAndConcatenateLists = (objValue, srcValue) => { - if (_.isArray(objValue)) { - return objValue.concat(srcValue); - } - } - - private mergeValuesButOverrideLists = (objValue, srcValue) => { - if (_.isArray(objValue)) { - return srcValue; - } - } -} diff --git a/packages/core/src/decorators/pending.ts b/packages/core/src/decorators/pending.ts new file mode 100644 index 00000000000..7eb92bf3eab --- /dev/null +++ b/packages/core/src/decorators/pending.ts @@ -0,0 +1 @@ +// class-level diff --git a/packages/core/src/decorators/step.ts b/packages/core/src/decorators/step.ts new file mode 100644 index 00000000000..6545c0780b9 --- /dev/null +++ b/packages/core/src/decorators/step.ts @@ -0,0 +1 @@ +// performAs level; sets a toString; deprecated diff --git a/packages/core/src/domain/events.ts b/packages/core/src/domain/events.ts deleted file mode 100644 index 660bb1618fd..00000000000 --- a/packages/core/src/domain/events.ts +++ /dev/null @@ -1,22 +0,0 @@ -import * as moment from 'moment'; -import { Outcome, PhotoReceipt, RecordedActivity, RecordedScene, Tag } from './model'; - -export class DomainEvent { - private type: string; - - constructor(public value: T, public timestamp?: number) { - this.timestamp = timestamp || moment().valueOf(); - this.type = this.constructor.name; - } - - toString() { - return `${this.timestamp} | ${this.constructor.name}: ${this.value.toString()}`; - } -} - -export class SceneStarts extends DomainEvent {} -export class ActivityStarts extends DomainEvent {} -export class ActivityFinished extends DomainEvent> {} -export class SceneTagged extends DomainEvent> {} -export class SceneFinished extends DomainEvent> {} -export class PhotoAttempted extends DomainEvent {} diff --git a/packages/core/src/domain/events/ActivityBegins.ts b/packages/core/src/domain/events/ActivityBegins.ts new file mode 100644 index 00000000000..cd16472a99f --- /dev/null +++ b/packages/core/src/domain/events/ActivityBegins.ts @@ -0,0 +1,14 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { ActivityDetails, Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class ActivityBegins extends DomainEvent { + constructor( + public readonly value: ActivityDetails, + timestamp?: Timestamp, + ) { + super(timestamp); + ensure('value', value, isDefined()); + } +} diff --git a/packages/core/src/domain/events/ActivityFinished.ts b/packages/core/src/domain/events/ActivityFinished.ts new file mode 100644 index 00000000000..5e3cf42008f --- /dev/null +++ b/packages/core/src/domain/events/ActivityFinished.ts @@ -0,0 +1,16 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { ActivityDetails, Outcome, Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class ActivityFinished extends DomainEvent { + constructor( + public readonly value: ActivityDetails, + public readonly outcome: Outcome, + timestamp?: Timestamp, + ) { + super(timestamp); + ensure('value', value, isDefined()); + ensure('outcome', outcome, isDefined()); + } +} diff --git a/packages/core/src/domain/events/ArtifactGenerated.ts b/packages/core/src/domain/events/ArtifactGenerated.ts new file mode 100644 index 00000000000..5942ae38552 --- /dev/null +++ b/packages/core/src/domain/events/ArtifactGenerated.ts @@ -0,0 +1,15 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { Artifact } from '../../io'; +import { Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class ArtifactGenerated extends DomainEvent { + constructor( + public readonly artifact: Artifact, + timestamp?: Timestamp, + ) { + super(timestamp); + ensure('value', artifact, isDefined()); + } +} diff --git a/packages/core/src/domain/events/AsyncOperationAttempted.ts b/packages/core/src/domain/events/AsyncOperationAttempted.ts new file mode 100644 index 00000000000..d33f119c8fb --- /dev/null +++ b/packages/core/src/domain/events/AsyncOperationAttempted.ts @@ -0,0 +1,14 @@ +import { StageCrewMember } from '../../stage'; +import { Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class AsyncOperationAttempted extends DomainEvent { + constructor( + public readonly crewMember: { new(...args: any[]): StageCrewMember }, + public readonly taskDescription: string, + public readonly value: Promise, + timestamp?: Timestamp, + ) { + super(timestamp); + } +} diff --git a/packages/core/src/domain/events/DomainEvent.ts b/packages/core/src/domain/events/DomainEvent.ts new file mode 100644 index 00000000000..e3983dab14b --- /dev/null +++ b/packages/core/src/domain/events/DomainEvent.ts @@ -0,0 +1,9 @@ +import { ensure, isDefined, TinyType } from 'tiny-types'; +import { Timestamp } from '../model'; + +export abstract class DomainEvent extends TinyType { + protected constructor(public readonly timestamp: Timestamp = new Timestamp()) { + super(); + ensure('timestamp', timestamp, isDefined()); + } +} diff --git a/packages/core/src/domain/events/ExecutionContextPropertyDetected.ts b/packages/core/src/domain/events/ExecutionContextPropertyDetected.ts new file mode 100644 index 00000000000..6f6bf408ea7 --- /dev/null +++ b/packages/core/src/domain/events/ExecutionContextPropertyDetected.ts @@ -0,0 +1,16 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { ScenarioDetails, Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class ExecutionContextPropertyDetected extends DomainEvent { + constructor( + public readonly scenarioDetails: ScenarioDetails, + public readonly value: T, + public readonly timestamp: Timestamp = new Timestamp(), + ) { + super(); + ensure('scenarioDetails', scenarioDetails, isDefined()); + ensure('timestamp', timestamp, isDefined()); + } +} diff --git a/packages/core/src/domain/events/SceneBegins.ts b/packages/core/src/domain/events/SceneBegins.ts new file mode 100644 index 00000000000..aa031fb1b4b --- /dev/null +++ b/packages/core/src/domain/events/SceneBegins.ts @@ -0,0 +1,14 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { ScenarioDetails, Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class SceneBegins extends DomainEvent { + constructor( + public readonly value: ScenarioDetails, + timestamp?: Timestamp, + ) { + super(timestamp); + ensure('value', value, isDefined()); + } +} diff --git a/packages/core/src/domain/events/SceneFinished.ts b/packages/core/src/domain/events/SceneFinished.ts new file mode 100644 index 00000000000..821291d5b51 --- /dev/null +++ b/packages/core/src/domain/events/SceneFinished.ts @@ -0,0 +1,16 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { Outcome, ScenarioDetails, Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class SceneFinished extends DomainEvent { + constructor( + public readonly value: ScenarioDetails, + public readonly outcome: Outcome, + timestamp?: Timestamp, + ) { + super(timestamp); + ensure('value', value, isDefined()); + ensure('outcome', outcome, isDefined()); + } +} diff --git a/packages/core/src/domain/events/SceneTagged.ts b/packages/core/src/domain/events/SceneTagged.ts new file mode 100644 index 00000000000..caf6f3c3453 --- /dev/null +++ b/packages/core/src/domain/events/SceneTagged.ts @@ -0,0 +1,15 @@ +import { ensure, isDefined } from 'tiny-types'; + +import { ScenarioDetails, Tag, Timestamp } from '../model'; +import { DomainEvent } from './DomainEvent'; + +export class SceneTagged extends DomainEvent { + constructor( + public readonly value: ScenarioDetails, + public readonly tag: Tag, + timestamp?: Timestamp, + ) { + super(timestamp); + ensure('value', value, isDefined()); + } +} diff --git a/packages/core/src/domain/events/index.ts b/packages/core/src/domain/events/index.ts new file mode 100644 index 00000000000..032f14e33d9 --- /dev/null +++ b/packages/core/src/domain/events/index.ts @@ -0,0 +1,9 @@ +export * from './ActivityBegins'; +export * from './ActivityFinished'; +export * from './ArtifactGenerated'; +export * from './AsyncOperationAttempted'; +export * from './DomainEvent'; +export * from './ExecutionContextPropertyDetected'; +export * from './SceneBegins'; +export * from './SceneFinished'; +export * from './SceneTagged'; diff --git a/packages/core/src/domain/model.ts b/packages/core/src/domain/model.ts deleted file mode 100644 index 093239b2bf1..00000000000 --- a/packages/core/src/domain/model.ts +++ /dev/null @@ -1,151 +0,0 @@ -export enum Result { - /** - * Failures due to external events or systems that compromise the validity of the test. - */ - COMPROMISED = 1 << 0, - /** - * Failure, due to some other exception. - */ - ERROR = 1 << 1, - - /** - * Failure, due to an assertion error - * For a test case, this means one of the tests in the test case failed. - */ - FAILURE = 1 << 2, - - /** - * The test step was not executed because a previous step in this test case failed. - * A whole test case can be skipped using tags or annotations to indicate that it is currently "work-in-progress" - */ - SKIPPED = 1 << 3, - - /** - * The test or test case was deliberately ignored. - * Tests can be ignored via the @Ignore annotation in JUnit, for example. - * Ignored tests are not considered the same as pending tests: a pending test is one that - * has been specified, but the corresponding code is yet to be implemented, whereas an - * ignored test can be a temporarily-deactivated test (during refactoring, for example). - */ - IGNORED = 1 << 4, - - /** - * A pending test is one that has been specified but not yet implemented. - * In a JUnit test case, you can use the (Thucydides) @Pending annotation to mark this. - * A pending test case is a test case that has at least one pending test. - */ - PENDING = 1 << 5, - - /** - * The test or test case ran as expected. - */ - SUCCESS = 1 << 6, - - Failed = COMPROMISED | ERROR | FAILURE, - Finished = Failed | SUCCESS, -} - -export interface Identifiable { - id: string; -} - -export class Tag { - private static Pattern = /^@([\w-]+)[:\s]?(.*)/i; - - public static from(text: string): Tag { - const [, type, values] = Tag.Pattern.exec(text); - - return new Tag( - type, - values.split(',').filter(_ => _.length > 0).map(_ => _.trim()), - ); - } - - constructor(public type: string, public values: string[] = []) { - } - - public get value() { - return this.values.join(', '); - } -} - -export class RecordedScene implements Identifiable { - constructor(public name: string, - public category: string, - public location: SourceLocation = new UnknownSourceLocation(), - public tags: Tag[] = [], - public id: string = `${category}:${name}`) { } - - equals(another: RecordedScene): boolean { - return (another instanceof RecordedScene) && - this.name === another.name && - this.category === another.category && - this.location.path === another.location.path && - this.location.line === another.location.line && - this.location.column === another.location.column; - // todo: tags are _probably_ not necessary ? - } - - toString() { - return this.name + - ` (category: ${this.category}, path: ${this.location.path}` + - when(!! this.location.line, ':' + this.location.line) + - when(!! this.location.column, ':' + this.location.column) + - `${when(this.id !== this.name, ', id: ' + this.id)})`; - } -} - -export interface SourceLocation { - path: string; - line?: number; - column?: number; -} - -export class UnknownSourceLocation implements SourceLocation { - path = undefined; - line = undefined; - column = undefined; -} - -export class RecordedActivity implements Identifiable { - - constructor(public name: string, public location: SourceLocation = new UnknownSourceLocation(), public id: string = name) { - } - - equals(another: RecordedActivity): boolean { - return (another instanceof RecordedActivity) && - this.name === another.name && - this.location.path === another.location.path && - this.location.line === another.location.line && - this.location.column === another.location.column && - this.id === another.id; - } - - toString() { - return `${this.name}${when(this.id !== this.name, ' (id: ' + this.id + ')')}`; - } -} - -export class Outcome { - constructor(public subject: T, public result: Result, public error?: Error) {} - - toString() { - return `${this.subject.toString()} (result: ${Result[this.result]}${when(!! this.error, ', error:' + this.error)})`; - } -} - -export class Photo { - constructor(public path: string) {} -} - -export class PhotoReceipt { - constructor(public activity: RecordedActivity, public photo: PromiseLike) {} - - toString() { - return this.activity.toString(); - } -} - -function when(condition: boolean, value: string): string { - return condition ? value : ''; -} diff --git a/packages/core/src/domain/model/ActivityDetails.ts b/packages/core/src/domain/model/ActivityDetails.ts new file mode 100644 index 00000000000..0997323ea90 --- /dev/null +++ b/packages/core/src/domain/model/ActivityDetails.ts @@ -0,0 +1,10 @@ +import { TinyType } from 'tiny-types'; + +import { Name } from './Name'; + +// todo: if ActivityDetails only contains the name, I might as well just get rid of it ... +export class ActivityDetails extends TinyType { + constructor(public readonly name: Name) { + super(); + } +} diff --git a/packages/core/src/domain/model/Category.ts b/packages/core/src/domain/model/Category.ts new file mode 100644 index 00000000000..4b06183d9d4 --- /dev/null +++ b/packages/core/src/domain/model/Category.ts @@ -0,0 +1,4 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class Category extends TinyTypeOf() { +} diff --git a/packages/core/src/domain/model/Duration.ts b/packages/core/src/domain/model/Duration.ts new file mode 100644 index 00000000000..7061260b7f2 --- /dev/null +++ b/packages/core/src/domain/model/Duration.ts @@ -0,0 +1,39 @@ +import { TinyType } from 'tiny-types'; + +export class Duration extends TinyType { + + private static msPerSecond = 1000; + private static msPerMinute = Duration.msPerSecond * 60; + private static msPerHour = Duration.msPerMinute * 60; + private static msPerDay = Duration.msPerHour * 24; + private static msPerYear = Duration.msPerDay * 365; + + static ofMillis = (milliseconds: number) => new Duration(milliseconds); + static ofSeconds = (seconds: number) => Duration.ofMillis(seconds * Duration.msPerSecond); + static ofMinutes = (minutes: number) => Duration.ofMillis(minutes * Duration.msPerMinute); + static ofHours = (hours: number) => Duration.ofMillis(hours * Duration.msPerHour); + static ofDays = (days: number) => Duration.ofMillis(days * Duration.msPerDay); + static ofYears = (years: number) => Duration.ofMillis(years * Duration.msPerYear); + + constructor(public readonly milliseconds: number) { + super(); + } + + toString() { + const ms = this.milliseconds; + + const levels = [ + [ Math.floor( ms / Duration.msPerYear), 'y'], + [ Math.floor( (ms % Duration.msPerYear) / Duration.msPerDay), 'd'], + [ Math.floor( ((ms % Duration.msPerYear) % Duration.msPerDay) / Duration.msPerHour), 'h'], + [ Math.floor((((ms % Duration.msPerYear) % Duration.msPerDay) % Duration.msPerHour) / Duration.msPerMinute), 'm'], + [ Math.floor((((ms % Duration.msPerYear) % Duration.msPerDay) % Duration.msPerHour) % Duration.msPerMinute / Duration.msPerSecond), 's'], + [ (((ms % Duration.msPerYear) % Duration.msPerDay) % Duration.msPerHour) % Duration.msPerMinute % Duration.msPerSecond, 'ms'], + ]; + + return levels.reduce((acc, l, i) => l[0] > 0 || i === levels.length + ? `${ acc } ${ l[0] }${ l[1] }` + : acc, + '').trim() || '0ms'; + } +} diff --git a/packages/core/src/domain/model/Name.ts b/packages/core/src/domain/model/Name.ts new file mode 100644 index 00000000000..618fbbab60d --- /dev/null +++ b/packages/core/src/domain/model/Name.ts @@ -0,0 +1,3 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class Name extends TinyTypeOf() {} diff --git a/packages/core/src/domain/model/Photo.ts b/packages/core/src/domain/model/Photo.ts new file mode 100644 index 00000000000..b24a8b8cec8 --- /dev/null +++ b/packages/core/src/domain/model/Photo.ts @@ -0,0 +1,17 @@ +import { ensure, isDefined, isString, Predicate, TinyType } from 'tiny-types'; + +export type Base64EncodedString = string; + +export class Photo extends TinyType { + + constructor(public readonly value: Base64EncodedString) { + super(); + ensure(Photo.name, value, isDefined(), isString(), looksLikeBase64Encoded()); + } +} + +function looksLikeBase64Encoded(): Predicate { + const regex = /^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)$/; + + return Predicate.to(`be an ISO-8601-compliant date`, (value: string) => regex.test(value)); +} diff --git a/packages/core/src/domain/model/ScenarioDetails.ts b/packages/core/src/domain/model/ScenarioDetails.ts new file mode 100644 index 00000000000..5061165f53f --- /dev/null +++ b/packages/core/src/domain/model/ScenarioDetails.ts @@ -0,0 +1,16 @@ +import { TinyType } from 'tiny-types'; + +import { FileSystemLocation } from '../../io'; +import { Category } from './Category'; +import { Name } from './Name'; + +export class ScenarioDetails extends TinyType { + + constructor( + public readonly name: Name, + public readonly category: Category, + public readonly location: FileSystemLocation, + ) { + super(); + } +} diff --git a/packages/core/src/domain/model/TestRunnerType.ts b/packages/core/src/domain/model/TestRunnerType.ts new file mode 100644 index 00000000000..c4e2809d265 --- /dev/null +++ b/packages/core/src/domain/model/TestRunnerType.ts @@ -0,0 +1,3 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class TestRunnerType extends TinyTypeOf() { } diff --git a/packages/core/src/domain/model/Timestamp.ts b/packages/core/src/domain/model/Timestamp.ts new file mode 100644 index 00000000000..7c2ff000ee9 --- /dev/null +++ b/packages/core/src/domain/model/Timestamp.ts @@ -0,0 +1,48 @@ +import * as moment from 'moment'; +import { ensure, isDefined, Predicate, TinyType } from 'tiny-types'; + +import { Duration } from './Duration'; + +export class Timestamp extends TinyType { + static fromJSON = (v: string) => new Timestamp(new Date(ensure(Timestamp.name, v, isSerialisedISO8601Date()))); + static fromMillisecondTimestamp = (v: number) => new Timestamp(moment(v).toDate()); + + constructor(public readonly value: Date = new Date()) { + super(); + ensure(Timestamp.name, value, isDefined(), isInstanceOf(Date)); + } + + diff(another: Timestamp): Duration { + return new Duration(Math.abs(moment(this.value).diff(another.value, 'ms', true))); + } + + plus(duration: Duration): Timestamp { + return new Timestamp(moment(this.value).add(duration.milliseconds, 'ms').toDate()); + } + + less(duration: Duration): Timestamp { + return new Timestamp(moment(this.value).subtract(duration.milliseconds, 'ms').toDate()); + } + + toMillisecondTimestamp(): number { + return moment(this.value).valueOf(); + } + + toJSON(): string { + return this.value.toJSON(); + } + + toString(): string { + return this.value.toString(); + } +} + +function isSerialisedISO8601Date(): Predicate { + return Predicate.to(`be an ISO-8601-compliant date`, (value: string) => + moment(value, moment.ISO_8601, true).isValid()); +} + +function isInstanceOf(type: Function & { new(...args: any[]): T }): Predicate { + return Predicate.to(`be an instance of ${ type.name }`, (value: T) => + value instanceof type); +} diff --git a/packages/core/src/domain/model/index.ts b/packages/core/src/domain/model/index.ts new file mode 100644 index 00000000000..e4236b685d3 --- /dev/null +++ b/packages/core/src/domain/model/index.ts @@ -0,0 +1,10 @@ +export * from './ActivityDetails'; +export * from './Category'; +export * from './Duration'; +export * from './Name'; +export * from './outcomes'; +export * from './Photo'; +export * from './tags'; +export * from './ScenarioDetails'; +export * from './TestRunnerType'; +export * from './Timestamp'; diff --git a/packages/core/src/domain/model/outcomes.ts b/packages/core/src/domain/model/outcomes.ts new file mode 100644 index 00000000000..11e61a2d62b --- /dev/null +++ b/packages/core/src/domain/model/outcomes.ts @@ -0,0 +1,78 @@ +import { TinyType } from 'tiny-types'; + +export abstract class Outcome extends TinyType { + protected constructor(protected readonly code: number) { + super(); + } +} + +export abstract class ProblemIndication extends Outcome { + protected constructor(protected readonly error: Error, code: number) { + super(code); + } +} + +/** + * Indicates a failure due to external events or systems that compromise the validity of the test. + */ +export class ExecutionCompromised extends ProblemIndication { + constructor(public readonly error: Error) { + super(error, 1 << 0); + } +} + +/** + * Indicates a failure due to an error other than recognised external system and assertion failures + */ +export class ErrorOccurred extends ProblemIndication { + constructor(public readonly error: Error) { + super(error, 1 << 1); + } +} + +/** + * Execution of an Activity or Scene has failed due to an assertion error; + */ +export class AssertionFailed extends ProblemIndication { + constructor(public readonly error: Error) { + super(error, 1 << 2); + } +} + +/** + * The Activity was not executed because a previous one has failed. + * A whole Scene can be marked as skipped to indicate that it is currently "work-in-progress" + */ +export class ExecutionSkipped extends Outcome { + constructor() { + super(1 << 3); + } +} + +/** + * The Activity was deliberately ignored and will not be executed. + */ +export class ExecutionIgnored extends Outcome { + constructor() { + super(1 << 4); + } +} + +/** + * A pending Activity is one that has been specified but not yet implemented. + * A pending Scene is one that has at least one pending Activity. + */ +export class ImplementationPending extends Outcome { + constructor() { + super(1 << 5); + } +} + +/** + * Scenario or activity ran as expected. + */ +export class ExecutionSuccessful extends Outcome { + constructor() { + super(1 << 6); + } +} diff --git a/packages/core/src/domain/model/tags/ArbitraryTag.ts b/packages/core/src/domain/model/tags/ArbitraryTag.ts new file mode 100644 index 00000000000..a0d32e326df --- /dev/null +++ b/packages/core/src/domain/model/tags/ArbitraryTag.ts @@ -0,0 +1,10 @@ +import { Tag } from './Tag'; + +/** + * Tagged with an arbitrary tag that doesn't have any special interpretation such as @regression, @wip, etc. + */ +export class ArbitraryTag extends Tag { + constructor(value: string) { + super(value, 'tag'); + } +} diff --git a/packages/core/src/domain/model/tags/BrowserTag.ts b/packages/core/src/domain/model/tags/BrowserTag.ts new file mode 100644 index 00000000000..1fe2a3fd76a --- /dev/null +++ b/packages/core/src/domain/model/tags/BrowserTag.ts @@ -0,0 +1,7 @@ +import { Tag } from './Tag'; + +export class BrowserTag extends Tag { + constructor(browser: string) { + super(browser, 'browser'); + } +} diff --git a/packages/core/src/domain/model/tags/CapabilityTag.ts b/packages/core/src/domain/model/tags/CapabilityTag.ts new file mode 100644 index 00000000000..b746bfee380 --- /dev/null +++ b/packages/core/src/domain/model/tags/CapabilityTag.ts @@ -0,0 +1,7 @@ +import { Tag } from './Tag'; + +export class CapabilityTag extends Tag { + constructor(capability: string) { + super(capability, 'capability'); + } +} diff --git a/packages/core/src/domain/model/tags/ContextTag.ts b/packages/core/src/domain/model/tags/ContextTag.ts new file mode 100644 index 00000000000..5725392872a --- /dev/null +++ b/packages/core/src/domain/model/tags/ContextTag.ts @@ -0,0 +1,16 @@ +import { Tag } from './Tag'; + +/** + * There are a couple of common use-cases for contexts: running the same test in different browsers, + * and running the same test on different operating systems. + * If you use the name of a browser (e.g. “chrome”, “firefox”, “safari”, “ie”), + * the context will be represented in the reports as the icon of the respective browsers. + * If you provide an operating system (e.g. “linux”, “windows”, “mac”, “android”, “iphone”), + * a similar icon will be used. If you use any other term for your context, + * it will appear in text form in the test results lists, so it is better to keep context names relatively short. + */ +export class ContextTag extends Tag { + constructor(context: string) { + super(context, 'context'); + } +} diff --git a/packages/core/src/domain/model/tags/FeatureTag.ts b/packages/core/src/domain/model/tags/FeatureTag.ts new file mode 100644 index 00000000000..07671bd95d4 --- /dev/null +++ b/packages/core/src/domain/model/tags/FeatureTag.ts @@ -0,0 +1,7 @@ +import { Tag } from './Tag'; + +export class FeatureTag extends Tag { + constructor(feature: string) { + super(feature, 'feature'); + } +} diff --git a/packages/core/src/domain/model/tags/IssueTag.ts b/packages/core/src/domain/model/tags/IssueTag.ts new file mode 100644 index 00000000000..6c5c0271582 --- /dev/null +++ b/packages/core/src/domain/model/tags/IssueTag.ts @@ -0,0 +1,7 @@ +import { Tag } from './Tag'; + +export class IssueTag extends Tag { + constructor(issueId: string) { + super(issueId, 'issue'); + } +} diff --git a/packages/core/src/domain/model/tags/ManualTag.ts b/packages/core/src/domain/model/tags/ManualTag.ts new file mode 100644 index 00000000000..a24cef4575c --- /dev/null +++ b/packages/core/src/domain/model/tags/ManualTag.ts @@ -0,0 +1,7 @@ +import { Tag } from './Tag'; + +export class ManualTag extends Tag { + constructor() { + super('Manual', 'External Tests'); + } +} diff --git a/packages/core/src/domain/model/tags/Tag.ts b/packages/core/src/domain/model/tags/Tag.ts new file mode 100644 index 00000000000..149a30bda84 --- /dev/null +++ b/packages/core/src/domain/model/tags/Tag.ts @@ -0,0 +1,11 @@ +import { TinyType } from 'tiny-types'; + +export abstract class Tag extends TinyType { + protected constructor(public readonly name: string, public readonly type: string) { + super(); + } + + toJSON(): { name: string, type: string } { + return super.toJSON() as { name: string, type: string }; + } +} diff --git a/packages/core/src/domain/model/tags/Tags.ts b/packages/core/src/domain/model/tags/Tags.ts new file mode 100644 index 00000000000..45523c45421 --- /dev/null +++ b/packages/core/src/domain/model/tags/Tags.ts @@ -0,0 +1,16 @@ +import { match } from 'tiny-types'; + +import { ArbitraryTag, IssueTag, ManualTag, Tag } from '.'; + +export class Tags { + private static Pattern = /^@([\w-]+)[:\s]?(.*)/i; + + public static from(text: string): Tag[] { + const [ , type, val ] = Tags.Pattern.exec(text); + + return match(type.toLowerCase()) + .when('manual', _ => [ new ManualTag() ]) + .when(/issues?/, _ => val.split(',').map(value => new IssueTag(value.trim()))) + .else(value => [ new ArbitraryTag(value.trim()) ]); + } +} diff --git a/packages/core/src/domain/model/tags/ThemeTag.ts b/packages/core/src/domain/model/tags/ThemeTag.ts new file mode 100644 index 00000000000..6a8ee157dd4 --- /dev/null +++ b/packages/core/src/domain/model/tags/ThemeTag.ts @@ -0,0 +1,7 @@ +import { Tag } from './Tag'; + +export class ThemeTag extends Tag { + constructor(theme: string) { + super(theme, 'theme'); + } +} diff --git a/packages/core/src/domain/model/tags/index.ts b/packages/core/src/domain/model/tags/index.ts new file mode 100644 index 00000000000..99218791578 --- /dev/null +++ b/packages/core/src/domain/model/tags/index.ts @@ -0,0 +1,10 @@ +export * from './ArbitraryTag'; +export * from './BrowserTag'; +export * from './CapabilityTag'; +export * from './ContextTag'; +export * from './FeatureTag'; +export * from './IssueTag'; +export * from './ManualTag'; +export * from './Tag'; +export * from './Tags'; +export * from './ThemeTag'; diff --git a/packages/core/src/errors/AsyncOperationError.ts b/packages/core/src/errors/AsyncOperationError.ts new file mode 100644 index 00000000000..4c6b115de99 --- /dev/null +++ b/packages/core/src/errors/AsyncOperationError.ts @@ -0,0 +1,7 @@ +import { RuntimeError } from './RuntimeError'; + +export class AsyncOperationError extends RuntimeError { + constructor(message: string, cause?: Error) { + super(AsyncOperationError, message, cause); + } +} diff --git a/packages/core/src/errors/RuntimeError.ts b/packages/core/src/errors/RuntimeError.ts new file mode 100644 index 00000000000..6ced3c30d73 --- /dev/null +++ b/packages/core/src/errors/RuntimeError.ts @@ -0,0 +1,16 @@ +export abstract class RuntimeError extends Error { + + protected constructor(type: { new(...args: any[]): RuntimeError } , message: string, cause?: Error) { + super(message); + Object.setPrototypeOf(this, type.prototype); + Error.captureStackTrace(this, type); + + if (!! cause) { + this.stack = `${ this.stack }\nCaused by: ${ cause.stack }`; + } + } + + toString() { + return `${ this.constructor.name }: ${ this.message }`; + } +} diff --git a/packages/core/src/errors/TestCompromisedError.ts b/packages/core/src/errors/TestCompromisedError.ts new file mode 100644 index 00000000000..0cb535a6087 --- /dev/null +++ b/packages/core/src/errors/TestCompromisedError.ts @@ -0,0 +1,7 @@ +import { RuntimeError } from './RuntimeError'; + +export class TestCompromisedError extends RuntimeError { + constructor(message: string, cause?: Error) { + super(TestCompromisedError, message, cause); + } +} diff --git a/packages/core/src/errors/index.ts b/packages/core/src/errors/index.ts new file mode 100644 index 00000000000..5020018e079 --- /dev/null +++ b/packages/core/src/errors/index.ts @@ -0,0 +1,3 @@ +export * from './AsyncOperationError'; +export * from './RuntimeError'; +export * from './TestCompromisedError'; diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index 8faf9d59af9..f785d8f47ea 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -1,5 +1,9 @@ -import { Serenity } from './serenity'; +import { Serenity } from './Serenity'; +import { Clock, StageManager } from './stage'; -// todo: probably export config too -export * from './serenity'; -export let serenity = new Serenity(); +const clock = new Clock(); +const stageManager = new StageManager(clock); + +export const serenity = new Serenity(stageManager); + +export * from './screenplay'; diff --git a/packages/core/src/integration/index.ts b/packages/core/src/integration/index.ts deleted file mode 100644 index 1d1aa9e0e6f..00000000000 --- a/packages/core/src/integration/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './test_framework_adapter'; diff --git a/packages/core/src/integration/test_framework_adapter.ts b/packages/core/src/integration/test_framework_adapter.ts deleted file mode 100644 index 14b6833bfa7..00000000000 --- a/packages/core/src/integration/test_framework_adapter.ts +++ /dev/null @@ -1,3 +0,0 @@ -export interface TestFrameworkAdapter { - run(specs: string[]): PromiseLike; -} diff --git a/packages/core/src/io/Artifact.ts b/packages/core/src/io/Artifact.ts new file mode 100644 index 00000000000..7def2d83c01 --- /dev/null +++ b/packages/core/src/io/Artifact.ts @@ -0,0 +1,14 @@ +import { TinyType } from 'tiny-types'; + +import { Name } from '../domain'; +import { FileType } from './FileType'; + +export class Artifact extends TinyType { + constructor( + public readonly name: Name, + public readonly type: FileType, + public readonly contents: T, + ) { + super(); + } +} diff --git a/packages/core/src/io/FileExtension.ts b/packages/core/src/io/FileExtension.ts new file mode 100644 index 00000000000..7818ecacb52 --- /dev/null +++ b/packages/core/src/io/FileExtension.ts @@ -0,0 +1,6 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class FileExtension extends TinyTypeOf() { + static JSON = new FileExtension('json'); + static PNG = new FileExtension('png'); +} diff --git a/packages/core/src/io/FileSystem.ts b/packages/core/src/io/FileSystem.ts new file mode 100644 index 00000000000..d85418ff9a8 --- /dev/null +++ b/packages/core/src/io/FileSystem.ts @@ -0,0 +1,47 @@ +import * as gracefulFs from 'graceful-fs'; +import * as mkdirp from 'mkdirp'; + +import { Path } from './Path'; + +export class FileSystem { + + constructor( + private readonly root: Path, + private readonly fs = gracefulFs, + ) { + } + + public store(relativePathToFile: Path, data: any, encoding?: string ): Promise { + return Promise.resolve(relativePathToFile) + .then(relativePath => this.prepareDirectory(relativePath)) + .then(absolutePath => this.write(absolutePath, data, encoding)); + } + + private prepareDirectory(relativePathToFile: Path): PromiseLike { + const + absolutePath = this.root.resolve(relativePathToFile), + parent = absolutePath.directory(); + + return new Promise((resolve, reject) => { + + mkdirp(parent.value, { fs: this.fs }, error => { + return error + ? reject(error) + : resolve(absolutePath); + }); + }); + } + + private write(path: Path, data: any, encoding?: string): Promise { + return new Promise((resolve, reject) => { + this.fs.writeFile( + path.value, + data, + encoding, + error => error + ? reject(error) + : resolve(path), + ); + }); + } +} diff --git a/packages/core/src/io/FileSystemLocation.ts b/packages/core/src/io/FileSystemLocation.ts new file mode 100644 index 00000000000..ce47b2bb645 --- /dev/null +++ b/packages/core/src/io/FileSystemLocation.ts @@ -0,0 +1,12 @@ +import { TinyType } from 'tiny-types'; +import { Path } from './Path'; + +export class FileSystemLocation extends TinyType { + constructor( + public readonly path: Path, + public readonly line?: number, + public readonly column?: number, + ) { + super(); + } +} diff --git a/packages/core/src/io/FileType.ts b/packages/core/src/io/FileType.ts new file mode 100644 index 00000000000..994f66d5629 --- /dev/null +++ b/packages/core/src/io/FileType.ts @@ -0,0 +1,15 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; +import { FileExtension } from './FileExtension'; +import { MimeType } from './MimeType'; + +export class FileType extends TinyType { + static JSON = new FileType(FileExtension.JSON, MimeType.Application_JSON); + static PNG = new FileType(FileExtension.PNG, MimeType.Image_PNG); + + constructor( + public readonly extesion: FileExtension, + public readonly mimeType: MimeType, + ) { + super(); + } +} diff --git a/packages/core/src/io/MimeType.ts b/packages/core/src/io/MimeType.ts new file mode 100644 index 00000000000..7e3ea30f6c1 --- /dev/null +++ b/packages/core/src/io/MimeType.ts @@ -0,0 +1,6 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class MimeType extends TinyTypeOf() { + public static Application_JSON = new MimeType('application/json'); + public static Image_PNG = new MimeType('image/png'); +} diff --git a/packages/core/src/io/Path.ts b/packages/core/src/io/Path.ts new file mode 100644 index 00000000000..a73d881a9c9 --- /dev/null +++ b/packages/core/src/io/Path.ts @@ -0,0 +1,26 @@ +import { ensure, isDefined, isGreaterThan, property, TinyType } from 'tiny-types'; + +import { posix } from 'path'; + +export class Path extends TinyType { + public readonly value: string; + + constructor(value: string) { + super(); + ensure(Path.name, value, isDefined(), property('length', isGreaterThan(0))); + + this.value = posix.normalize(value); + } + + join(another: Path) { + return new Path(posix.join(this.value, another.value)); + } + + resolve(another: Path) { + return new Path(posix.resolve(this.value, another.value)); + } + + directory() { + return new Path(posix.dirname(this.value)); + } +} diff --git a/packages/core/src/io/attempt_require.ts b/packages/core/src/io/attempt_require.ts deleted file mode 100644 index d57970247e0..00000000000 --- a/packages/core/src/io/attempt_require.ts +++ /dev/null @@ -1,9 +0,0 @@ -export function attemptToRequire(module: string) { - try { - return require(module); - } catch (e) { - throw new Error( - `This feature requires the '${ module }' module, which seems to be missing. To install it, run: ` + - `\`npm install ${ module } --save[-dev]\``); - } -} diff --git a/packages/core/src/io/file_system.ts b/packages/core/src/io/file_system.ts deleted file mode 100644 index 76059d01df8..00000000000 --- a/packages/core/src/io/file_system.ts +++ /dev/null @@ -1,49 +0,0 @@ -import * as gracefulFs from 'graceful-fs'; -import * as mkdirp from 'mkdirp'; -import * as path from 'path'; - -export class FileSystem { - - constructor( - private readonly root: string, - private readonly fs = gracefulFs, - ) { - } - - public store(relativePathToFile: string, data: any): Promise { - return this.ensureSpecified(relativePathToFile) - .then(relativePath => this.prepareDirectory(relativePath)) - .then(absolutePath => this.write(absolutePath, data)); - } - - private ensureSpecified(relativePathToFile: string): Promise { - return !! (relativePathToFile && relativePathToFile.length) - ? Promise.resolve(relativePathToFile) - : Promise.reject(new Error('Please specify where the file should be saved')); - } - - private prepareDirectory(relativePathToFile: string): PromiseLike { - const - absolutePath = path.resolve(this.root, relativePathToFile), - parent = path.dirname(absolutePath); - - return new Promise((resolve, reject) => { - - mkdirp(parent, { fs: this.fs }, error => { - return error - ? reject(error) - : resolve(absolutePath); - }); - }); - } - - private write(path: string, data: any): Promise { - return new Promise((resolve, reject) => { - this.fs.writeFile(path, data, error => { - return error - ? reject(error) - : resolve(path); - }); - }); - } -} diff --git a/packages/core/src/io/index.ts b/packages/core/src/io/index.ts index d0b41fc91b1..dffc91aa1d8 100644 --- a/packages/core/src/io/index.ts +++ b/packages/core/src/io/index.ts @@ -1,3 +1,7 @@ -export * from './attempt_require'; -export * from './file_system'; -export * from './json'; +export * from './Artifact'; +export * from './FileExtension'; +export * from './FileSystem'; +export * from './FileSystemLocation'; +export * from './FileType'; +export * from './MimeType'; +export * from './Path'; diff --git a/packages/core/src/io/json.ts b/packages/core/src/io/json.ts deleted file mode 100644 index df0eec0bae4..00000000000 --- a/packages/core/src/io/json.ts +++ /dev/null @@ -1,6 +0,0 @@ -export interface JSONObject { - [x: string]: string | number | boolean | Date | JSONObject | JSONArray; -} - -// tslint:disable-next-line:no-empty-interface - needed to define the JSONObject above -export interface JSONArray extends Array { } diff --git a/packages/core/src/recording/activity_description.ts b/packages/core/src/recording/activity_description.ts deleted file mode 100644 index 26b6e24ac30..00000000000 --- a/packages/core/src/recording/activity_description.ts +++ /dev/null @@ -1,37 +0,0 @@ -import { Activity } from '../screenplay/activities'; -import { Actor } from '../screenplay/actor'; - -const isActor = (candidate: any) => candidate instanceof Actor; - -const using = (source: any) => (token: string, field: string|number) => typeof source[field] === 'function' - ? stringify(token, source[field].bind(source)) - : stringify(token, source[field]); - -const includeActorName = (template: string, actor: Actor) => template.replace('#actor', actor.toString()); -const interpolateArguments = (template: string, parameters: any[]) => template.replace(/{(\d+)}/g, using(parameters)); -const interpolateFields = (template: string, activity: Activity) => template.replace(/#(\w+)/g, using(activity)); - -export function describeAs(template: string, ...parameters: any[]): string { - const first: any = parameters[0]; - - switch (true) { - case parameters.length > 1 || typeof first !== 'object': - return interpolateArguments(template, parameters); - - case isActor(first): - return includeActorName(interpolateArguments(template, parameters), first); - - default: - return interpolateFields(template, first); - } -} - -function stringify(token: string, value: any): string { - switch ({}.toString.call(value)) { - case '[object Function]': return stringify(token, value()); - case '[object Array]': return value.map(item => stringify(token, item)).join(', '); - case '[object Object]': return value.toString(); - case '[object Undefined]': return token; - default: return value; - } -} diff --git a/packages/core/src/recording/async.ts b/packages/core/src/recording/async.ts deleted file mode 100644 index 0c436197cb0..00000000000 --- a/packages/core/src/recording/async.ts +++ /dev/null @@ -1,19 +0,0 @@ -// todo: move to "io" -export function defer(fn: () => PromiseLike): Promise { - return new Promise( (resolve, reject) => { - fn().then(resolve, reject); - }); -} - -export class Deferred { - public promise: Promise; - public resolve: (T?) => void; - public reject: (Error) => void; - - constructor() { - this.promise = new Promise( (resolve, reject) => { - this.resolve = resolve; - this.reject = reject; - }); - } -} diff --git a/packages/core/src/recording/index.ts b/packages/core/src/recording/index.ts deleted file mode 100644 index fd6547da5a7..00000000000 --- a/packages/core/src/recording/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -export * from './activity_description'; -export * from './step_annotation'; diff --git a/packages/core/src/recording/step_annotation.ts b/packages/core/src/recording/step_annotation.ts deleted file mode 100644 index 91006d75650..00000000000 --- a/packages/core/src/recording/step_annotation.ts +++ /dev/null @@ -1,31 +0,0 @@ -import { Activity } from '../screenplay'; -import { describeAs } from './activity_description'; - -export class Step { - - describedUsing(template: string): StepAnnotation { - - return (target: T, propertyKey: string, descriptor: PerformAsMethodSignature) => { - - if (this.usesOldDescriptionStyle(target)) { - target.toString = function() { - return describeAs(template, this); - }; - } - - return descriptor; - }; - } - - private usesOldDescriptionStyle(activity: Activity) { - return activity.toString() === '[object Object]'; - } -} - -export function step(stepDescriptionTemplate: string): StepAnnotation { - return new Step().describedUsing(stepDescriptionTemplate); -} - -export type PerformAsMethodSignature = TypedPropertyDescriptor<(PerformsTasks) => PromiseLike>; - -export type StepAnnotation = (target: T, propertyKey: string, descriptor: PerformAsMethodSignature) => PerformAsMethodSignature; diff --git a/packages/core/src/reporting/console_reporter.ts b/packages/core/src/reporting/console_reporter.ts deleted file mode 100644 index bc6fd0667a9..00000000000 --- a/packages/core/src/reporting/console_reporter.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { DomainEvent } from '../domain/events'; -import { Stage, StageCrewMember } from '../stage'; - -import moment = require('moment'); -import util = require('util'); - -export type MessagePrinter = (message: string) => void; - -export function consoleReporter(print: MessagePrinter = console.log): StageCrewMember { - return new ConsoleReporter(print); -} - -export class ConsoleReporter implements StageCrewMember { - private static Events_of_Interest = [ DomainEvent ]; - private stage: Stage; - - constructor(private print: MessagePrinter) { - } - - assignTo(stage: Stage) { - this.stage = stage; - - this.stage.manager.registerInterestIn(ConsoleReporter.Events_of_Interest, this); - } - - notifyOf(event: DomainEvent): void { - this.print(util.format('%s | %s: %s', - moment(event.timestamp).format('HH:mm:ss.SSS'), - event.constructor.name, - event.value, - )); - } -} diff --git a/packages/core/src/reporting/index.ts b/packages/core/src/reporting/index.ts deleted file mode 100644 index 601ec68a5bb..00000000000 --- a/packages/core/src/reporting/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -export * from './rehearsal_report'; -export * from './report_exporter'; -export * from './console_reporter'; -export * from './serenity_bdd_report'; -export * from './serenity_bdd_reporter'; diff --git a/packages/core/src/reporting/rehearsal_report.ts b/packages/core/src/reporting/rehearsal_report.ts deleted file mode 100644 index 241d2a59d40..00000000000 --- a/packages/core/src/reporting/rehearsal_report.ts +++ /dev/null @@ -1,157 +0,0 @@ -import { - ActivityFinished, - ActivityStarts, - DomainEvent, - Outcome, - Photo, - PhotoAttempted, - RecordedActivity, - RecordedScene, - SceneFinished, - SceneStarts, - SceneTagged, - Tag, -} from '../domain'; -import { ReportExporter } from './report_exporter'; - -export class RehearsalReport { - static from(events: Array>): RehearsalPeriod { - let previousNode: ReportPeriod; - let currentNode: ReportPeriod; - let currentScene: ScenePeriod; - - return events.reduce((fullReport, event) => { - switch (event.constructor) { // tslint:disable-line:switch-default - ignore other events - case SceneStarts: - currentScene = fullReport.append(new ScenePeriod(event)) as ScenePeriod; - currentNode = currentScene; - break; - case ActivityStarts: - currentNode = currentNode.append(new ActivityPeriod(event)); - break; - case SceneFinished: - currentNode = currentNode.concludeWith(event); - break; - case ActivityFinished: - // The Photographer triggers a PhotoAttempted event after the ActivityFinished, - // that's why we need to cache both the previous and the current node - previousNode = currentNode; - currentNode = currentNode.concludeWith(event); - break; - case SceneTagged: - currentScene.tagWithPromised(event.value); - break; - case PhotoAttempted: - [previousNode, currentNode] - .filter(node => !! node && node.matches(event.value.activity)) - .forEach(node => node.attach(event.value.photo)); - break; - } - - return fullReport; - }, new RehearsalPeriod()); - } -} - -export abstract class ReportPeriod { - public parent: ReportPeriod; - public value: T; - - public children: Array> = []; - public outcome: Outcome; - - public startedAt: number; - protected finishedAt: number; - - private promisedPhotos: Array> = []; - - constructor(start: DomainEvent) { - this.value = start.value; - this.startedAt = start.timestamp; - } - - abstract matches(finished: T): boolean; - - concludeWith(finished: DomainEvent>) { - this.finishedAt = finished.timestamp; - this.outcome = finished.value; - - if (! this.parent) { - return this; - } - - return this.matches(finished.value.subject) - ? this.parent - : this.parent.concludeWith(finished); - } - - attach(promisedPhoto: PromiseLike) { - this.promisedPhotos.push(promisedPhoto); - } - - photos(): PromiseLike { - // todo: maybe use some constant rather than a blunt "undefined"? - return Promise.all(this.promisedPhotos).then(photos => photos.filter(p => p !== undefined)); - } - - duration() { - return this.finishedAt - this.startedAt; - } - - append(child: ReportPeriod): ReportPeriod { - child.parent = this; - this.children.push(child); - - return child; - } - - abstract exportedUsing(exporter: ReportExporter): PromiseLike; -} - -export class RehearsalPeriod extends ReportPeriod { - matches(finished: Rehearsal): boolean { - return false; - } - - exportedUsing(exporter: ReportExporter): PromiseLike { - return exporter.exportRehearsal(this); - } - - constructor() { - super(new DomainEvent(new Rehearsal())); // todo: DomainEvent? Meh. Can I do better? - this.parent = undefined; - } -} - -export class Rehearsal { -} - -export class ActivityPeriod extends ReportPeriod { - matches(another: RecordedActivity): boolean { - return this.value.equals(another); - } - - exportedUsing(exporter: ReportExporter): PromiseLike { - return exporter.exportActivity(this); - } -} - -export class ScenePeriod extends ReportPeriod { - private tags: Array> = []; - - matches(another: RecordedScene): boolean { - return this.value.equals(another); - } - - exportedUsing(exporter: ReportExporter): PromiseLike { - return exporter.exportScene(this); - } - - tagWithPromised(tag: PromiseLike) { - this.tags.push(tag); - } - - promisedTags() { - return Promise.all(this.tags); - } -} diff --git a/packages/core/src/reporting/report_exporter.ts b/packages/core/src/reporting/report_exporter.ts deleted file mode 100644 index 7ebf21db45f..00000000000 --- a/packages/core/src/reporting/report_exporter.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { ActivityPeriod, RehearsalPeriod, ScenePeriod } from './rehearsal_report'; - -export interface ReportExporter { - exportRehearsal (node: RehearsalPeriod): PromiseLike; - exportScene (node: ScenePeriod): PromiseLike; - exportActivity (node: ActivityPeriod): PromiseLike; -} diff --git a/packages/core/src/reporting/serenity_bdd_report.ts b/packages/core/src/reporting/serenity_bdd_report.ts deleted file mode 100644 index 7b9158e89e6..00000000000 --- a/packages/core/src/reporting/serenity_bdd_report.ts +++ /dev/null @@ -1,76 +0,0 @@ -import { JSONObject } from '../io/json'; - -/** - * A JSON object which needs to be returned to Protractor when SerenityProtractorFramework - * is done with executing the tests. - * - * @link https://github.com/angular/protractor/blob/master/lib/frameworks/README.md#requirements - */ -export interface FullReport extends JSONObject { - scenes: SceneReport[]; -} - -export interface SceneReport extends JSONObject { - id: string; - title: string; - name: string; - description: string; - context: string; - testSource?: string; - // testCaseName: string; - startTime: number; - duration: number; - sessionId?: string; - manual: boolean; - result: string; - userStory: UserStoryReport; - tags: TagReport[]; - issues: string[]; - testSteps: ActivityReport[]; - - testFailureCause?: ErrorReport; - testFailureClassname?: string; - testFailureMessage?: string; - annotatedResult?: string; -} - -export interface ActivityReport extends JSONObject { - number?: number; - description: string; - duration: number; - startTime: number; - screenshots: ScreenshotReport[]; - result: string; - children?: ActivityReport[]; - exception?: ErrorReport; -} - -export interface UserStoryReport extends JSONObject { - id: string; - storyName: string; - storyClassName?: string; - path: string; - type: string; -} - -export interface TagReport extends JSONObject { - name: string; - type: string; -} - -export interface ErrorReport extends JSONObject { - errorType: string; - message: string; - stackTrace: ErrorReportStackFrame[]; -} - -export interface ErrorReportStackFrame extends JSONObject { - declaringClass: string; - methodName: string; - fileName: string; - lineNumber: number; -} - -export interface ScreenshotReport extends JSONObject { - screenshot: string; -} diff --git a/packages/core/src/reporting/serenity_bdd_reporter.ts b/packages/core/src/reporting/serenity_bdd_reporter.ts deleted file mode 100644 index b4f8f134f16..00000000000 --- a/packages/core/src/reporting/serenity_bdd_reporter.ts +++ /dev/null @@ -1,289 +0,0 @@ -import * as _ from 'lodash'; -import * as path from 'path'; -import StackTrace = require('stacktrace-js'); -import { StackFrame } from 'stacktrace-js'; -import { Md5 } from 'ts-md5/dist/md5'; - -import { serenity } from '../'; -import { DomainEvent, Photo, RecordedScene, Result, SceneFinished, Tag } from '../domain'; -import { FileSystem, JSONObject } from '../io'; -import { Stage, StageCrewMember } from '../stage'; -import { ActivityPeriod, RehearsalPeriod, ReportExporter, ScenePeriod } from './index'; -import { RehearsalReport } from './rehearsal_report'; -import { - ActivityReport, - ErrorReport, - ErrorReportStackFrame, - FullReport, - SceneReport, - ScreenshotReport, - TagReport, -} from './serenity_bdd_report'; - -export function serenityBDDReporter( - requirementsDirectory: string = serenity.config.requirementsDirectory, - outputDirectory: string = serenity.config.outputDirectory, -): StageCrewMember { - return new SerenityBDDReporter(requirementsDirectory, new FileSystem(outputDirectory)); -} - -export class SerenityBDDReporter implements StageCrewMember { - - private static Events_of_Interest = [ SceneFinished ]; - private stage: Stage; - - constructor(private readonly requirementsDirectory, private readonly fs: FileSystem) { - } - - assignTo(stage: Stage) { - this.stage = stage; - this.stage.manager.registerInterestIn(SerenityBDDReporter.Events_of_Interest, this); - } - - notifyOf(event: DomainEvent): void { - switch (event.constructor) { // tslint:disable-line:switch-default - ignore other events - case SceneFinished: return this.persistReport(); - } - } - - private persistReport() { - this.stage.manager.informOfWorkInProgress( - RehearsalReport.from(this.stage.manager.readNewJournalEntriesAs('SerenityBDDReporter')) - .exportedUsing(new SerenityBDDReportExporter(this.requirementsDirectory)) - .then((fullReport: FullReport) => Promise.all( - fullReport.scenes.map( - (scene: SceneReport) => this.fs.store(reportFileNameFor(scene), JSON.stringify(scene)), - ), - )), - ); - } -} - -function reportFileNameFor(scene: SceneReport): string { - const id = scene.id, - tags = (scene.tags || []).map(t => `${t.type}:${t.name}`).join('-'); - - return Md5.hashStr(`${id}-${tags}`) + '.json'; -} - -// todo: extract - -class Tags { - private readonly tags: Tag[]; - - constructor(...tags: Tag[]) { - this.tags = tags; - } - - ofType(type: string) { - return this.tags.filter(tag => tag.type === type); - } - - process = (...fns: Array<(tags: Tag[]) => Tag[]>) => fns.reduce((tags, fn) => fn(tags), this.tags); -} - -const splitIssueTags = (tags: Tag[]) => { - const isAnIssue = (tag: Tag): boolean => !! ~['issue', 'issues'].indexOf(tag.type); - const breakDownIssues = (tag: Tag) => isAnIssue(tag) - ? tag.values.map(issueId => new Tag('issue', [ issueId ])) - : tag; - - return _.chain(tags) - .map(breakDownIssues) - .flatten() - .value() as Tag[]; -}; - -const addCapabilityAndFeatureTags = (scene: RecordedScene, pathToScenario: string) => (tags: Tag[]) => { - - const nonEmpty = (...elements: T[]) => elements.filter(e => !! e); - - const join = (...elements: string[]) => nonEmpty(...elements).join('/'); - - const underscoresToSpaces = (dirname: string) => dirname.replace(/_+/g, ' '); - const capitaliseFirstLetter = (text: string) => text && text[0].toUpperCase() + text.slice(1); - - const relativePath = path.dirname(pathToScenario); - const subDirectories = (relativePath !== '.') - ? relativePath.split(path.sep).map(underscoresToSpaces).map(capitaliseFirstLetter).reverse() - : []; - - const feature = scene.category; - const capability = subDirectories[0]; - const theme = subDirectories[1]; - - return tags.concat(nonEmpty( - new Tag('feature', [ join(capability, feature) ]), - capability && new Tag('capability', [ join(theme, capability) ]), - theme && new Tag('theme', [ theme ]), - )); -}; - -const tagAsManualIfNeeded = (tags: Tag[]) => tags.concat(...tags.filter(tag => tag.type === 'manual').map(t => new Tag('External Tests', ['Manual']))); - -const dashify = (text: string) => text - .replace(/([a-z])([A-Z])/g, '$1-$2') - .replace(/[ \t\W]/g, '-') - .replace(/^-+|-+$/g, '') - .toLowerCase(); - -// / todo: extract - -/** - * Transforms the tree structure of the RehearsalPeriod to a format acceptable by Protractor - */ -export class SerenityBDDReportExporter implements ReportExporter { - - private errorExporter = new ErrorExporter(); - private photoExporter = new PhotoExporter(); - - constructor(private readonly requirementsDirectory) { - } - - exportRehearsal(node: RehearsalPeriod): PromiseLike { - return Promise.all(node.children.map(child => child.exportedUsing(this))) - .then(children => ({ - scenes: children, - })); - } - - exportScene(node: ScenePeriod): PromiseLike { - return Promise.all(node.children.map(child => child.exportedUsing(this))) - .then((children: ActivityReport[]) => this.errorExporter.tryToExport(node.outcome.error).then(error => { - return node.promisedTags().then(promisedTags => { - - const - scene = node.value, - pathToScenario = path.relative(this.requirementsDirectory, scene.location.path), - - tags = new Tags(...scene.tags, ...promisedTags), - allTags = tags.process( - splitIssueTags, - tagAsManualIfNeeded, - addCapabilityAndFeatureTags(scene, pathToScenario), - ); - - return ({ - id: this.idOf(node, allTags), - name: this.idOf(node, allTags), - - context: tags.ofType('context').map(tag => tag.value).pop(), - manual: !! tags.ofType('manual').pop(), - tags: this.serialisedTags(allTags), - - title: scene.name, - description: '', - startTime: node.startedAt, - duration: node.duration(), - testSource: 'cucumber', // todo: provide the correct test source - - userStory: { - id: dashify(scene.category), - path: pathToScenario, - storyName: scene.category, - type: 'feature', - }, - - issues: this.issuesCoveredBy(scene), - testSteps: children, - - result: Result[ node.outcome.result ], - annotatedResult: Result[ node.outcome.result ], - testFailureCause: error, - }); - }); - })); - } - - exportActivity(node: ActivityPeriod): PromiseLike { - return Promise.all(node.children.map(child => child.exportedUsing(this))) - .then((children: ActivityReport[]) => Promise.all([ node.photos(), this.errorExporter.tryToExport(node.outcome.error)]).then( r => ({ - description: node.value.name, - duration: node.duration(), - startTime: node.startedAt, - screenshots: this.photoExporter.tryToExport(r[0]), - result: Result[node.outcome.result], - children, - exception: r[1], // this.errorExporter.tryToExport(node.outcome.error), - }))); - } - - private idOf(node: ScenePeriod, tags: Tag[]) { - const asString = (t: Tag) => !! t.value ? `${ t.type }:${t.value}` : t.type ; - const combined = (ts: Tag[]) => (tags || []).map(asString).join(';').replace(' ', ''); - - return [ - node.value.name, - combined(tags), - ].map(dashify).join(';').replace(/;$/, ''); - } - - private issuesCoveredBy(scene: RecordedScene): string[] { - const onlyIssueTags = this.isAnIssue, - toIssueIds = (tag: Tag): string[] => tag.values; - - return _.chain(scene.tags).filter(onlyIssueTags).map(toIssueIds).flatten().uniq().value() as string[]; - } - - private serialisedTags(tags: Tag[]): TagReport[] { - - function serialise(tag: Tag) { - const noValue = (t: Tag) => ({ name: t.type, type: 'tag' }), - withValue = (t: Tag) => ({ name: t.values.join(','), type: t.type }); - - return tag.values.length === 0 - ? noValue(tag) - : withValue(tag); - } - - return _.chain(tags) - .map(serialise) - .uniqBy('name') - .value(); - } - - private isAnIssue = (tag: Tag): boolean => !! ~['issue', 'issues'].indexOf(tag.type); -} - -class PhotoExporter { - tryToExport(photos: Photo[]): ScreenshotReport[] { - return this.ifNotEmpty(photos.map(photo => ({ screenshot: path.basename(photo.path) }))); - } - - private ifNotEmpty = (list: T[]): T[] => !! list.length ? list : undefined; -} - -class ErrorExporter { - tryToExport(error: Error): PromiseLike { - if (! error) { - return Promise.resolve(undefined); // an undefined JSON field does not get serialised and that's what Serenity BDD expects - } - - return this.stackTraceOf(error).then(frames => ({ - errorType: error.name, - message: error.message, - stackTrace: frames, - })); - } - - private stackTraceOf(error: Error): PromiseLike { - return !! error.stack ? this.parsedStackTraceOf(error) : Promise.resolve([]); - } - - private parsedStackTraceOf(error: Error): PromiseLike { - const - serenityCode = /node_modules[\\/]serenity/, - onlyIfFound = index => !! ~index ? index : undefined, - firstSerenityStackFrame = (stack: StackFrame[]): number => onlyIfFound(stack.findIndex(frame => !! serenityCode.exec(frame.fileName))), - stack = StackTrace.fromError(error); - - return stack.then(frames => frames.slice(0, firstSerenityStackFrame(frames)).map(frame => { - return { - declaringClass: '', - methodName: `${ frame.functionName }(${ (frame.args || []).join(', ') })`, - fileName: frame.fileName, - lineNumber: frame.lineNumber, - }; - })); - } -} diff --git a/packages/core/src/screenplay/Ability.ts b/packages/core/src/screenplay/Ability.ts new file mode 100644 index 00000000000..70bc4fa3923 --- /dev/null +++ b/packages/core/src/screenplay/Ability.ts @@ -0,0 +1,7 @@ +import { UsesAbilities } from './actor'; + +export interface Ability {} // tslint:disable-line:no-empty-interface +export interface AbilityType { + new (...args): A; + as(actor: UsesAbilities): A; +} diff --git a/packages/core/src/screenplay/Activity.ts b/packages/core/src/screenplay/Activity.ts new file mode 100644 index 00000000000..f84665c05a4 --- /dev/null +++ b/packages/core/src/screenplay/Activity.ts @@ -0,0 +1,6 @@ +import { AnswersQuestions, PerformsTasks, UsesAbilities } from './actor'; + +export interface Activity { + performAs(actor: PerformsTasks | UsesAbilities | AnswersQuestions): PromiseLike; + toString(): string; +} diff --git a/packages/core/src/screenplay/Interaction.ts b/packages/core/src/screenplay/Interaction.ts new file mode 100644 index 00000000000..1126e2d3c15 --- /dev/null +++ b/packages/core/src/screenplay/Interaction.ts @@ -0,0 +1,27 @@ +import { Activity } from './Activity'; +import { AnswersQuestions, UsesAbilities } from './actor'; + +export abstract class Interaction implements Activity { + static where(description: string, interaction: (actor: UsesAbilities & AnswersQuestions) => PromiseLike | void): Interaction { + return new AnonymousInteraction(description, interaction); + } + + abstract performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike; +} + +class AnonymousInteraction implements Interaction { + constructor(private description: string, private interaction: (actor: UsesAbilities & AnswersQuestions) => PromiseLike | void) { + } + + performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike { + try { + return Promise.resolve(this.interaction(actor)); + } catch (error) { + return Promise.reject(error); + } + } + + toString() { + return this.description; + } +} diff --git a/packages/core/src/screenplay/Question.ts b/packages/core/src/screenplay/Question.ts new file mode 100644 index 00000000000..d1fca4bdbb2 --- /dev/null +++ b/packages/core/src/screenplay/Question.ts @@ -0,0 +1,22 @@ +import { UsesAbilities } from './actor'; + +export abstract class Question { + static about(description: string, body: (actor: UsesAbilities) => R): Question { + return new AnonymousQuestion(description, body); + } + + abstract answeredBy(actor: UsesAbilities): T; +} + +class AnonymousQuestion implements Question { + constructor(private description: string, private body: (actor: UsesAbilities) => T) { + } + + answeredBy(actor: UsesAbilities) { + return this.body(actor); + } + + toString() { + return this.description; + } +} diff --git a/packages/core/src/screenplay/Task.ts b/packages/core/src/screenplay/Task.ts new file mode 100644 index 00000000000..f2de6ebaf17 --- /dev/null +++ b/packages/core/src/screenplay/Task.ts @@ -0,0 +1,28 @@ +import { Activity } from './Activity'; +import { PerformsTasks } from './actor'; + +export abstract class Task implements Activity { + static where(description: string, ...activities: Activity[]): Task { + // todo: if there are no activities, make it a PendingActivity + return new AnonymousTask(description, activities); + + // return activities.length > 0 + // ? new AnonymousTask(description, activities) + // : new PendingActivity(); + } + + abstract performAs(actor: PerformsTasks): PromiseLike; +} + +class AnonymousTask implements Task { + constructor(private description: string, private activities: Activity[]) { + } + + performAs(actor: PerformsTasks): PromiseLike { + return actor.attemptsTo(...this.activities); + } + + toString() { + return this.description; + } +} diff --git a/packages/core/src/screenplay/abilities/index.ts b/packages/core/src/screenplay/abilities/index.ts deleted file mode 100644 index 97e1bd563f8..00000000000 --- a/packages/core/src/screenplay/abilities/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './take_notes'; diff --git a/packages/core/src/screenplay/abilities/take_notes.ts b/packages/core/src/screenplay/abilities/take_notes.ts deleted file mode 100644 index 915c0189640..00000000000 --- a/packages/core/src/screenplay/abilities/take_notes.ts +++ /dev/null @@ -1,26 +0,0 @@ -import { Ability, UsesAbilities } from '../actor'; - -export interface Notepad { - [x: string]: PromiseLike; -} - -export class TakeNotes implements Ability { - - static usingAnEmptyNotepad = () => TakeNotes.using({}); - static using = (notepad: Notepad) => new TakeNotes(notepad); - - static as(actor: UsesAbilities): TakeNotes { - return actor.abilityTo(TakeNotes); - } - - note = (topic: string, contents: PromiseLike | any) => (this.notepad[topic] = contents, Promise.resolve()); - - read(topic: string): PromiseLike { - return !! this.notepad[topic] - ? Promise.resolve(this.notepad[topic]) - : Promise.reject(new Error(`I don\'t have any notes on the topic of "${ topic }"`)); - } - - constructor(private notepad: Notepad) { - } -} diff --git a/packages/core/src/screenplay/activities.ts b/packages/core/src/screenplay/activities.ts deleted file mode 100644 index 5bb09c00821..00000000000 --- a/packages/core/src/screenplay/activities.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { AnswersQuestions, PerformsTasks, UsesAbilities } from './actor'; - -export abstract class Task implements Activity { - static where = (description: string, ...activities: Activity[]): Task => new AnonymousTask(description, activities); - - abstract performAs(actor: PerformsTasks): PromiseLike; -} - -export abstract class Interaction implements Activity { - static where = (description: string, interaction: (actor: UsesAbilities & AnswersQuestions) => PromiseLike): Interaction => - new AnonymousInteraction(description, interaction); - - abstract performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike; -} - -export interface Activity { - performAs(actor: PerformsTasks | UsesAbilities | AnswersQuestions): PromiseLike; -} - -class AnonymousTask implements Task { - constructor(private description: string, private activities: Activity[]) { - } - - performAs = (actor: PerformsTasks) => actor.attemptsTo(...this.activities); - - toString = () => this.description; -} - -class AnonymousInteraction implements Interaction { - constructor(private description: string, private interaction: (actor: UsesAbilities & AnswersQuestions) => PromiseLike) { - } - - performAs = (actor: UsesAbilities & AnswersQuestions) => this.interaction(actor); - - toString = () => this.description; -} diff --git a/packages/core/src/screenplay/activities/ActivityDescriber.ts b/packages/core/src/screenplay/activities/ActivityDescriber.ts new file mode 100644 index 00000000000..50280784c3e --- /dev/null +++ b/packages/core/src/screenplay/activities/ActivityDescriber.ts @@ -0,0 +1,18 @@ +import { Name } from '../../domain'; +import { Activity } from '../Activity'; + +export class ActivityDescriber { + + // todo: if the name can't be determined, make one up + describe(activity: Activity, actor: { toString: () => string }): Name { + const template = activity.toString(); + + return new Name( + this.includeActorName(template, actor), + ); + } + + private includeActorName(template: string, actor: { toString: () => string }) { + return template.replace('#actor', actor.toString()); + } +} diff --git a/packages/core/src/screenplay/activities/OutcomeMatcher.ts b/packages/core/src/screenplay/activities/OutcomeMatcher.ts new file mode 100644 index 00000000000..b03563453b6 --- /dev/null +++ b/packages/core/src/screenplay/activities/OutcomeMatcher.ts @@ -0,0 +1,14 @@ +import { match } from 'tiny-types'; +import { AssertionFailed, ErrorOccurred, ExecutionCompromised, ProblemIndication } from '../../domain/model/outcomes'; +import { TestCompromisedError } from '../../errors'; + +export class OutcomeMatcher { + outcomeFor(error: Error | any): ProblemIndication { + return match(error) + .when(TestCompromisedError, _ => new ExecutionCompromised(error)) + .when(Error, _ => /AssertionError/.test(error.constructor.name) + ? new AssertionFailed(error) + : new ErrorOccurred(error)) + .else(_ => new ErrorOccurred(error)); + } +} diff --git a/packages/core/src/screenplay/activities/TrackedActivity.ts b/packages/core/src/screenplay/activities/TrackedActivity.ts new file mode 100644 index 00000000000..32ff5cad970 --- /dev/null +++ b/packages/core/src/screenplay/activities/TrackedActivity.ts @@ -0,0 +1,40 @@ +import { ActivityBegins, ActivityDetails, ActivityFinished, ExecutionSuccessful } from '../../domain'; +import { Clock, StageManager } from '../../stage'; +import { Activity } from '../Activity'; +import { AnswersQuestions, PerformsTasks, UsesAbilities } from '../actor'; +import { ActivityDescriber } from './ActivityDescriber'; +import { OutcomeMatcher } from './OutcomeMatcher'; + +export class TrackedActivity implements Activity { + + protected static readonly describer = new ActivityDescriber(); + protected static readonly outcomes = new OutcomeMatcher(); + + constructor( + protected readonly activity: Activity, + protected readonly stageManager: StageManager, + protected readonly clock: Clock, + ) { + } + + performAs(actor: PerformsTasks | UsesAbilities | AnswersQuestions): PromiseLike { + const details = new ActivityDetails( + // todo: I might an id here to make sure the events match up + TrackedActivity.describer.describe(this.activity, actor), + ); + + return Promise.resolve() + .then(() => this.stageManager.notifyOf(new ActivityBegins(details, this.clock.now()))) + .then(() => this.activity.performAs(actor)) + .then(() => { + const outcome = new ExecutionSuccessful(); + this.stageManager.notifyOf(new ActivityFinished(details, outcome, this.clock.now())); + }) + .catch(e => { + const outcome = TrackedActivity.outcomes.outcomeFor(e); + this.stageManager.notifyOf(new ActivityFinished(details, outcome, this.clock.now())); + + throw e; + }); + } +} diff --git a/packages/core/src/screenplay/activities/index.ts b/packages/core/src/screenplay/activities/index.ts new file mode 100644 index 00000000000..2261dac5d4f --- /dev/null +++ b/packages/core/src/screenplay/activities/index.ts @@ -0,0 +1 @@ +export * from './TrackedActivity'; diff --git a/packages/core/src/screenplay/actor.ts b/packages/core/src/screenplay/actor.ts deleted file mode 100644 index c4f9f3e8571..00000000000 --- a/packages/core/src/screenplay/actor.ts +++ /dev/null @@ -1,158 +0,0 @@ -import { serenity } from '..'; -import { ActivityFinished, ActivityStarts, Outcome, RecordedActivity, Result, SourceLocation } from '../domain'; -import { describeAs } from '../recording/activity_description'; -import { StageManager } from '../stage/stage_manager'; - -import { Activity } from './activities'; -import { Question } from './question'; - -import { StackFrame } from 'stacktrace-js'; -import StackTrace = require('stacktrace-js'); - -export interface Ability {} // tslint:disable-line:no-empty-interface -export interface AbilityConstructor { - new (...args): A; - as(actor: UsesAbilities): A; -} - -export interface PerformsTasks { - attemptsTo(...tasks: Activity[]): Promise; -} - -export interface UsesAbilities { - /** - * Gives the Actor the Abilities to perform Actions - * - * @param abilities - */ - whoCan(...abilities: Ability[]): UsesAbilities; - - /** - * Grants access to the Actor's ability - * - * @param doSomething Ability class name - */ - abilityTo(doSomething: AbilityConstructor): T; -} - -export interface AnswersQuestions { - toSee(question: Question): T; -} - -export class Actor implements PerformsTasks, UsesAbilities, AnswersQuestions { - - private tracker: ActivityTracker; - private abilities: { [id: string]: Ability } = {}; - - static named(name: string): Actor { - return new Actor(name, serenity.stageManager()); - } - - whoCan(...abilities: Ability[]): Actor { - abilities.forEach(ability => { - this.abilities[ability.constructor.name] = ability; - }); - - return this; - } - - abilityTo(doSomething: AbilityConstructor): T { - if (! this.can(doSomething)) { - throw new Error(`I don't have the ability to ${doSomething.name}, said ${this} sadly.`); - } - - return this.abilities[doSomething.name] as T; - } - - attemptsTo(...activities: Activity[]): Promise { - return activities.map(this.tracker.track).reduce((previous: Promise, current: Activity) => { - return previous.then(() => current.performAs(this)); - }, Promise.resolve(null)); - } - - toSee(question: Question): T { - return question.answeredBy(this); - } - - toString(): string { - return this.name; - } - - constructor(private name: string, stage_manager: StageManager) { - this.tracker = new ActivityTracker(stage_manager); - } - - private can(doSomething: AbilityConstructor): boolean { - return !! this.abilities[doSomething.name]; - } -} - -class ActivityTracker { - track = (activity: Activity) => this.shouldTrack(activity) ? new TrackedActivity(activity, this.stage_manager) : activity; - - constructor(private stage_manager: StageManager) { - } - - private shouldTrack = (activity: Activity) => activity.toString() !== '[object Object]'; -} - -class TrackedActivity implements Activity { - - private location: Promise; - - performAs(actor: PerformsTasks | UsesAbilities | AnswersQuestions): PromiseLike { - const description = describeAs(this.activity.toString(), actor); - - return this.location.then(location => { - - const recorded_activity = new RecordedActivity(description, location); - - return Promise.resolve() - .then(() => this.beforeStep(recorded_activity)) - .then(() => this.activity.performAs(actor)) - .then(() => this.afterStep(recorded_activity), e => this.onFailure(recorded_activity, e)) as PromiseLike; - }); - } - - constructor(private activity: Activity, private stage_manager: StageManager) { - this.location = locateCallerOf('Actor.attemptsTo'); - } - - private beforeStep(activity: RecordedActivity) { - this.stage_manager.notifyOf(new ActivityStarts(activity)); - } - - private afterStep(activity: RecordedActivity) { - this.stage_manager.notifyOf(new ActivityFinished(new Outcome(activity, Result.SUCCESS))); - } - - private onFailure(activity: RecordedActivity, error: Error) { - this.stage_manager.notifyOf(new ActivityFinished(new Outcome(activity, this.resultFrom(error), error))); - - return Promise.reject(error); - } - - // todo: extract - private resultFrom(error: Error): Result { - const constructorOf = e => e && e.constructor ? e.constructor.name : ''; - - // todo: sniff the exception to find out about the Result. Did the test fail, or was it compromised? - return /AssertionError/.test(constructorOf(error)) - ? Result.FAILURE - : Result.ERROR; - } -} - -// todo: extract -function locateCallerOf(method: string) { - const origin_of = (frames: StackFrame[]): number => frames.findIndex(frame => !! frame.functionName && !! ~frame.functionName.indexOf(method)); - const get_frame = (frames: StackFrame[]): StackFrame => frames[origin_of(frames) + 1]; - const frames_of_interest = (frame: StackFrame) => frame && frame.fileName && !~ frame.fileName.indexOf('node_modules'); - const to_location = (frame: StackFrame): SourceLocation => (frame && { - path: frame.fileName, - line: frame.lineNumber, - column: frame.columnNumber, - }); - - return StackTrace.get({ filter: frames_of_interest }).then(get_frame).then(to_location); -} diff --git a/packages/core/src/screenplay/actor/Actor.ts b/packages/core/src/screenplay/actor/Actor.ts new file mode 100644 index 00000000000..e2550ac8171 --- /dev/null +++ b/packages/core/src/screenplay/actor/Actor.ts @@ -0,0 +1,69 @@ +import { TestCompromisedError } from '../../errors'; +import { serenity } from '../../index'; +import { Clock, StageManager } from '../../stage'; +import { Ability, AbilityType } from '../Ability'; +import { TrackedActivity } from '../activities'; +import { Activity } from '../Activity'; +import { Question } from '../Question'; +import { AnswersQuestions } from './AnswersQuestions'; +import { PerformsTasks } from './PerformsTasks'; +import { UsesAbilities } from './UsesAbilities'; + +export class Actor implements PerformsTasks, UsesAbilities, AnswersQuestions { + private readonly abilities = new Map, Ability>(); + + static named(name: string): Actor { + return new Actor(name, serenity.stageManager, new Clock()); + } + + // todo: Actor should have execution strategies + // todo: the default one executes every activity + // todo: there could be a dry-run mode that default to skip strategy + + constructor( + private readonly name: string, + private readonly stageManager: StageManager, + private readonly clock: Clock, + ) { + } + + abilityTo(doSomething: AbilityType): T { + if (! this.can(doSomething)) { + throw new TestCompromisedError(`${ this } can't ${ doSomething.name } yet. ` + + `Did you give them the ability to do so?`); + } + + return this.abilities.get(doSomething) as T; + } + + attemptsTo(...activities: Activity[]): Promise { + return activities + .map(activity => new TrackedActivity(activity, this.stageManager, this.clock)) + .reduce((previous: Promise, current: Activity) => { + return previous.then(() => + /* todo: add an execution strategy */ + current.performAs(this), + ); + }, Promise.resolve(null)); + } + + toSee(question: Question): T { + return question.answeredBy(this); + } + + whoCan(...abilities: Ability[]): Actor { + abilities.forEach(ability => { + this.abilities.set(ability.constructor as AbilityType, ability); + }); + + return this; + } + + toString() { + return this.name; + } + + private can(doSomething: AbilityType): boolean { + return this.abilities.has(doSomething); + } +} diff --git a/packages/core/src/screenplay/actor/AnswersQuestions.ts b/packages/core/src/screenplay/actor/AnswersQuestions.ts new file mode 100644 index 00000000000..4b7fca54be8 --- /dev/null +++ b/packages/core/src/screenplay/actor/AnswersQuestions.ts @@ -0,0 +1,5 @@ +import { Question } from '../Question'; + +export interface AnswersQuestions { + toSee(question: Question): T; +} diff --git a/packages/core/src/screenplay/actor/PerformsTasks.ts b/packages/core/src/screenplay/actor/PerformsTasks.ts new file mode 100644 index 00000000000..15b1b24099d --- /dev/null +++ b/packages/core/src/screenplay/actor/PerformsTasks.ts @@ -0,0 +1,5 @@ +import { Activity } from '../Activity'; + +export interface PerformsTasks { + attemptsTo(...tasks: Activity[]): Promise; +} diff --git a/packages/core/src/screenplay/actor/UsesAbilities.ts b/packages/core/src/screenplay/actor/UsesAbilities.ts new file mode 100644 index 00000000000..40191226d65 --- /dev/null +++ b/packages/core/src/screenplay/actor/UsesAbilities.ts @@ -0,0 +1,19 @@ +import { Ability, AbilityType } from '../Ability'; + +export interface UsesAbilities { + /** + * Gives an Actor the Abilities to perform Activities + * + * @param {Ability} abilities + * @returns {UsesAbilities} + */ + whoCan(...abilities: Ability[]): UsesAbilities; + + /** + * Grants access to the Actor's ability + * + * @param {AbilityType} doSomething + * @returns {T} + */ + abilityTo(doSomething: AbilityType): T; +} diff --git a/packages/core/src/screenplay/actor/index.ts b/packages/core/src/screenplay/actor/index.ts new file mode 100644 index 00000000000..d20931aa148 --- /dev/null +++ b/packages/core/src/screenplay/actor/index.ts @@ -0,0 +1,4 @@ +export * from './Actor'; +export * from './AnswersQuestions'; +export * from './PerformsTasks'; +export * from './UsesAbilities'; diff --git a/packages/core/src/screenplay/expectations.ts b/packages/core/src/screenplay/expectations.ts deleted file mode 100644 index d64fd53bd9f..00000000000 --- a/packages/core/src/screenplay/expectations.ts +++ /dev/null @@ -1,4 +0,0 @@ -import { OneOrMany } from './lists'; - -export type Assertion = (actual: A) => PromiseLike; -export type Expectation> | OneOrMany> = (expected: OneOrMany) => Assertion; diff --git a/packages/core/src/screenplay/index.ts b/packages/core/src/screenplay/index.ts index 58c51e6ae95..64d9eba024b 100644 --- a/packages/core/src/screenplay/index.ts +++ b/packages/core/src/screenplay/index.ts @@ -1,6 +1,7 @@ -export * from './abilities'; -export * from './activities'; export * from './actor'; +export * from './Ability'; +export * from './Activity'; +export * from './Interaction'; export * from './interactions'; -export * from './question'; -export * from './tasks'; +export * from './Question'; +export * from './Task'; diff --git a/packages/core/src/screenplay/interactions/See.ts b/packages/core/src/screenplay/interactions/See.ts new file mode 100644 index 00000000000..db21709e348 --- /dev/null +++ b/packages/core/src/screenplay/interactions/See.ts @@ -0,0 +1,37 @@ +import { AnswersQuestions, Interaction, Question } from '..'; + +export type PromisedAssertion = (actual: A) => PromiseLike; +export type Assertion = (actual: A) => void; + +export class See implements Interaction { + static if = (question: Question, assertion: Assertion | PromisedAssertion) => new See(question, assertion); + + constructor( + private question: Question, + private assert: Assertion | PromisedAssertion, + ) { + } + + performAs(actor: AnswersQuestions): PromiseLike { + return new Promise((resolve, reject) => { + try { + const result = this.assert(actor.toSee(this.question)); + + if (this.isAPromiseOf(result)) { + return result.then(resolve, reject); + } + + resolve(void 0); + } + catch (error) { + reject(error); // todo: an opportunity for a custom assertion error with diffs + } + }); + } + + toString = () => `{0} checks ${this.question}`; + + private isAPromiseOf(value: any): value is PromiseLike { + return !! value && !! value.then; + } +} diff --git a/packages/core/src/screenplay/interactions/compare_notes.ts b/packages/core/src/screenplay/interactions/compare_notes.ts deleted file mode 100644 index 29756b61b16..00000000000 --- a/packages/core/src/screenplay/interactions/compare_notes.ts +++ /dev/null @@ -1,32 +0,0 @@ -import { TakeNotes } from '../abilities'; -import { Interaction } from '../activities'; -import { AnswersQuestions, UsesAbilities } from '../actor'; -import { Expectation } from '../expectations'; -import { OneOrMany } from '../lists'; -import { Question } from '../question'; - -export class CompareNotes> | OneOrMany> implements Interaction { - static toSeeIf> | OneOrMany>( - question: Question, - expectation: Expectation, - topic: { toString: () => string }, - ) { - return new CompareNotes(question, expectation, topic.toString()); - } - - performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike { - return TakeNotes. - as(actor). - read(this.topic). - then(expected => this.expect(expected)(actor.toSee(this.actual))); - } - - constructor(private actual: Question, private expect: Expectation, private topic: string) { - } - - toString = () => `{0} compares notes on ${this.subject()}`; - - private subject = () => `${ this.actual }` === `${ this.topic }` - ? `${ this.actual }` - : `${ this.actual } (noted as "${this.topic})` -} diff --git a/packages/core/src/screenplay/interactions/index.ts b/packages/core/src/screenplay/interactions/index.ts index 91e19b60ec5..0e11bd159b8 100644 --- a/packages/core/src/screenplay/interactions/index.ts +++ b/packages/core/src/screenplay/interactions/index.ts @@ -1,3 +1 @@ -export * from './compare_notes'; -export * from './see'; -export * from './take_note'; +export * from './See'; diff --git a/packages/core/src/screenplay/interactions/see.ts b/packages/core/src/screenplay/interactions/see.ts deleted file mode 100644 index 0378181a979..00000000000 --- a/packages/core/src/screenplay/interactions/see.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { AnswersQuestions, Interaction, Question } from '..'; -import { Assertion } from '../expectations'; - -export class See implements Interaction { - static if = (question: Question, assertion: Assertion) => new See(question, assertion); - - performAs(actor: AnswersQuestions): PromiseLike { - return this.assert(actor.toSee(this.question)); - } - - constructor(private question: Question, private assert: Assertion) { - } - - toString = () => `{0} checks ${this.question}`; -} diff --git a/packages/core/src/screenplay/interactions/take_note.ts b/packages/core/src/screenplay/interactions/take_note.ts deleted file mode 100644 index 501ab2af840..00000000000 --- a/packages/core/src/screenplay/interactions/take_note.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { Interaction, Question, TakeNotes, UsesAbilities } from '../index'; - -export class TakeNote implements Interaction { - static of = (question: Question) => new TakeNote(question, question); - - as = (topic: string) => (this.topic = topic, this); - - performAs(actor: UsesAbilities): PromiseLike { - return TakeNotes.as(actor).note(this.topic.toString(), this.question.answeredBy(actor)); - } - - constructor(private question: Question, private topic: { toString: () => string }) { - } - - toString = () => `{0} takes a note of ${this.subject()}`; - - private subject = () => `${ this.question }` === `${ this.topic }` - ? `${ this.question }` - : `${ this.question } (noted as "${this.topic})` -} diff --git a/packages/core/src/screenplay/lists.ts b/packages/core/src/screenplay/lists.ts deleted file mode 100644 index 2bf1ad300a8..00000000000 --- a/packages/core/src/screenplay/lists.ts +++ /dev/null @@ -1,2 +0,0 @@ -export type List = Item[]; -export type OneOrMany = T | List; diff --git a/packages/core/src/screenplay/question.ts b/packages/core/src/screenplay/question.ts deleted file mode 100644 index 1fcd8315326..00000000000 --- a/packages/core/src/screenplay/question.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { UsesAbilities } from './actor'; - -export abstract class Question { - static about = (description: string, body: (actor: UsesAbilities) => R): Question => - new AnonymousQuestion(description, body); - - abstract answeredBy(actor: UsesAbilities): T; -} - -class AnonymousQuestion implements Question { - constructor(private description: string, private body: (actor: UsesAbilities) => T) { - } - - answeredBy = (actor: UsesAbilities) => this.body(actor); - - toString = () => this.description; -} diff --git a/packages/core/src/screenplay/tasks/check.ts b/packages/core/src/screenplay/tasks/check.ts deleted file mode 100644 index fc901e089d8..00000000000 --- a/packages/core/src/screenplay/tasks/check.ts +++ /dev/null @@ -1,69 +0,0 @@ -import { Activity, Task } from '../activities'; -import { PerformsTasks, UsesAbilities } from '../actor'; -import { Question } from '../question'; - -const - isBoolean = (v: any): v is boolean => v === true || v === false, - isQuestion = (v: any): v is Question => !! v.answeredBy; - -export abstract class Check { - static whether(condition: boolean | Question | Question>) { - return ({ - andIfSo: (...activities: Activity[]): Activity & Check => { - if (isBoolean(condition)) { - return new ActivitiesConditionalOnBoolean(condition, activities, []); - } - if (isQuestion(condition)) { - return new ActivitiesConditionalOnQuestion(condition, activities, []); - } - }, - }); - } - - abstract otherwise(...activities: Activity[]): Activity & Check; -} - -class ActivitiesConditionalOnBoolean implements Task, Check { - constructor(private readonly condition: boolean, - private readonly activitiesWhenConditionIsMet: Activity[], - private readonly activitiesWhenConditionIsNotMet: Activity[]) { - } - - otherwise(...activities: Activity[]): Activity & Check { - return new ActivitiesConditionalOnBoolean(this.condition, this.activitiesWhenConditionIsMet, activities); - } - - performAs(actor: PerformsTasks): PromiseLike { - return actor.attemptsTo(...(this.condition - ? this.activitiesWhenConditionIsMet - : this.activitiesWhenConditionIsNotMet - )); - } -} - -class ActivitiesConditionalOnQuestion implements Task, Check { - constructor(private readonly condition: Question | Question>, - private readonly activitiesWhenConditionIsMet: Activity[], - private readonly activitiesWhenConditionIsNotMet: Activity[]) { - } - - otherwise(...activities: Activity[]): Activity & Check { - return new ActivitiesConditionalOnQuestion(this.condition, this.activitiesWhenConditionIsMet, activities); - } - - performAs(actor: PerformsTasks & UsesAbilities): PromiseLike { - const answer = this.condition.answeredBy(actor); - - if (isBoolean(answer)) { - return actor.attemptsTo(...(answer - ? this.activitiesWhenConditionIsMet - : this.activitiesWhenConditionIsNotMet - )); - } - - return answer.then(result => actor.attemptsTo(...(result - ? this.activitiesWhenConditionIsMet - : this.activitiesWhenConditionIsNotMet - ))); - } -} diff --git a/packages/core/src/screenplay/tasks/index.ts b/packages/core/src/screenplay/tasks/index.ts deleted file mode 100644 index 01a8e34b6c0..00000000000 --- a/packages/core/src/screenplay/tasks/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './check'; diff --git a/packages/core/src/serenity.ts b/packages/core/src/serenity.ts deleted file mode 100644 index 6ea209c4871..00000000000 --- a/packages/core/src/serenity.ts +++ /dev/null @@ -1,42 +0,0 @@ -import { Config } from './config'; -import { DomainEvent } from './domain/events'; -import { Cast, Journal, Stage, StageCrewMember, StageManager } from './stage'; - -export class Serenity { - private stage: Stage = new Stage(new StageManager(new Journal())); - private configuration: Config> = new Config({ - cwd: process.cwd(), - crew: [], - parameters: {}, - stageCueTimeout: 30 * 1000, - requirementsDirectory: `${process.cwd()}/features`, - outputDirectory: `${process.cwd()}/target/site/serenity/`, - }); - - callToStageFor = (cast: Cast): Stage => this.stage.enter(cast); - - notify(event: DomainEvent) { - this.stage.manager.notifyOf(event); - } - - stageManager = () => this.stage.manager; - - configure(config: SerenityConfig) { - this.configuration = new Config(config).withFallback(this.configuration.get); - - this.configuration.get.crew.forEach(crewMember => crewMember.assignTo(this.stage)); - } - - get config(): SerenityConfig { - return this.configuration.get; - } -} - -export interface SerenityConfig { - cwd?: string; - crew?: StageCrewMember[]; - parameters?: T; - stageCueTimeout?: number; - requirementsDirectory?: string; - outputDirectory?: string; -} diff --git a/packages/core/src/stage/Clock.ts b/packages/core/src/stage/Clock.ts new file mode 100644 index 00000000000..14723de7f94 --- /dev/null +++ b/packages/core/src/stage/Clock.ts @@ -0,0 +1,7 @@ +import { Timestamp } from '../domain/model'; + +export class Clock { + now() { + return new Timestamp(); + } +} diff --git a/packages/core/src/stage/Stage.ts b/packages/core/src/stage/Stage.ts new file mode 100644 index 00000000000..8b8655b0c15 --- /dev/null +++ b/packages/core/src/stage/Stage.ts @@ -0,0 +1,2 @@ +export class Stage { +} diff --git a/packages/core/src/stage/StageCrewMember.ts b/packages/core/src/stage/StageCrewMember.ts new file mode 100644 index 00000000000..8fd489e8488 --- /dev/null +++ b/packages/core/src/stage/StageCrewMember.ts @@ -0,0 +1,7 @@ +import { DomainEvent } from '../domain'; +import { StageManager } from './StageManager'; + +export interface StageCrewMember { + assignTo(stageManager: StageManager): void; + notifyOf(event: DomainEvent): void; +} diff --git a/packages/core/src/stage/StageManager.ts b/packages/core/src/stage/StageManager.ts new file mode 100644 index 00000000000..30bd084a280 --- /dev/null +++ b/packages/core/src/stage/StageManager.ts @@ -0,0 +1,33 @@ +import { match } from 'tiny-types'; + +import { AsyncOperationAttempted, DomainEvent } from '../domain'; +import { AsyncOperationError } from '../errors'; +import { Clock } from './Clock'; +import { StageCrewMember } from './StageCrewMember'; + +export class StageManager { + private readonly subscribers: StageCrewMember[] = []; + private readonly wip: Array> = []; + + constructor(private readonly clock = new Clock()) { + } + + register(stageCrewMember: StageCrewMember) { + this.subscribers.push(stageCrewMember); + } + + notifyOf(event: DomainEvent): void { + return match(event) + .when(AsyncOperationAttempted, (evt: AsyncOperationAttempted) => { + this.wip.push(evt.value.catch(error => Promise.reject(new AsyncOperationError( + `${ evt.crewMember.name } took ${ this.clock.now().diff(evt.timestamp) } to ${ evt.taskDescription } and has failed`, + error, + )))); + }) + .else(_ => this.subscribers.forEach(crewMember => crewMember.notifyOf(event))); + } + + waitForNextCue() { + return Promise.all(this.wip); + } +} diff --git a/packages/core/src/stage/crew/artifact-archiver/ArtifactArchiver.ts b/packages/core/src/stage/crew/artifact-archiver/ArtifactArchiver.ts new file mode 100644 index 00000000000..9a00e1d49f9 --- /dev/null +++ b/packages/core/src/stage/crew/artifact-archiver/ArtifactArchiver.ts @@ -0,0 +1,43 @@ +import * as sanitise from 'sanitize-filename'; +import { match } from 'tiny-types'; + +import { ArtifactGenerated, AsyncOperationAttempted, DomainEvent } from '../../../domain'; +import { FileSystem, FileType, Path } from '../../../io'; +import { StageCrewMember } from '../../StageCrewMember'; +import { StageManager } from '../../StageManager'; + +export class ArtifactArchiver implements StageCrewMember { + private stageManager: StageManager; + + constructor( + private readonly fileSystem: FileSystem, + ) { + } + + assignTo(stageManager: StageManager) { + this.stageManager = stageManager; + this.stageManager.register(this); + } + + notifyOf = (event: DomainEvent): void => match(event) + .when(ArtifactGenerated, this.handleArtifactGenerated) + .else(_ => void 0); + + private handleArtifactGenerated = ({ artifact }: ArtifactGenerated): void => { + + const filename = [ + sanitise(artifact.name.value), + artifact.type.extesion.value, + ].join('.'); + + const promise = match>(artifact.type) + .when(FileType.PNG, _ => this.fileSystem.store(new Path(filename), artifact.contents, 'base64')) + .else(_ => this.fileSystem.store(new Path(filename), JSON.stringify(artifact.contents), 'utf8')); + + this.stageManager.notifyOf(new AsyncOperationAttempted( + ArtifactArchiver, + `save '${ filename }'`, + promise.then(_ => void 0), + )); + } +} diff --git a/packages/core/src/stage/crew/artifact-archiver/index.ts b/packages/core/src/stage/crew/artifact-archiver/index.ts new file mode 100644 index 00000000000..1b54396dd09 --- /dev/null +++ b/packages/core/src/stage/crew/artifact-archiver/index.ts @@ -0,0 +1 @@ +export * from './ArtifactArchiver'; diff --git a/packages/core/src/stage/crew/index.ts b/packages/core/src/stage/crew/index.ts new file mode 100644 index 00000000000..128df689455 --- /dev/null +++ b/packages/core/src/stage/crew/index.ts @@ -0,0 +1,2 @@ +export * from './artifact-archiver'; +export * from './serenity-bdd-reporter'; diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/ErrorParser.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/ErrorParser.ts new file mode 100644 index 00000000000..c59c88b4e71 --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/ErrorParser.ts @@ -0,0 +1,17 @@ +import * as ErrorStackParser from 'error-stack-parser'; + +export class ErrorParser { + parse(error: Error) { + // todo: add an instanceof check perhaps? + return { + errorType: error.name, + message: error.message, + stackTrace: ErrorStackParser.parse(error).map(frame => ({ + declaringClass: '', + methodName: `${ frame.functionName }(${ (frame.args || []).join(', ') })`, + fileName: frame.fileName, + lineNumber: frame.lineNumber, + })), + }; + } +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/IDGenerator.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/IDGenerator.ts new file mode 100644 index 00000000000..e9b34166e83 --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/IDGenerator.ts @@ -0,0 +1,13 @@ +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class IDGenerator { + generateFrom(...args: Array) { + return args.map(arg => this.dashify(arg.value)).join(';'); + } + + private dashify = (text: string) => text + .replace(/([a-z])([A-Z])/g, '$1-$2') + .replace(/[ \t\W]/g, '-') + .replace(/^-+|-+$/g, '') + .toLowerCase(); +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/MD5Hash.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/MD5Hash.ts new file mode 100644 index 00000000000..69bb5f4638f --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/MD5Hash.ts @@ -0,0 +1,8 @@ +import { createHash } from 'crypto'; +import { TinyType, TinyTypeOf } from 'tiny-types'; + +export class MD5Hash extends TinyTypeOf() { + static of(value: string): MD5Hash { + return new MD5Hash(createHash('md5').update(value).digest('hex')); + } +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/ScenarioReport.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/ScenarioReport.ts new file mode 100644 index 00000000000..9021ee9e646 --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/ScenarioReport.ts @@ -0,0 +1,186 @@ +import { JSONObject, match } from 'tiny-types'; + +import { + ActivityDetails, + AssertionFailed, + BrowserTag, + ContextTag, + ErrorOccurred, + ExecutionCompromised, + ExecutionIgnored, + ExecutionSkipped, + ExecutionSuccessful, + FeatureTag, + ImplementationPending, + IssueTag, + ManualTag, Name, + Outcome, + ScenarioDetails, + Tag, + TestRunnerType, + Timestamp, +} from '../../../domain'; +import { ErrorParser } from './ErrorParser'; +import { IDGenerator } from './IDGenerator'; +import { ErrorDetails, SerenityBDDReport, TestStep } from './SerenityBDDJsonSchema'; + +export class ScenarioReport { + private static errorParser = new ErrorParser(); + private static idGenerator = new IDGenerator(); + + private readonly report: Partial & { children?: Array> }; + private readonly activities = new Stack>(); + + constructor(public readonly scenarioDetails: ScenarioDetails) { + + this.report = { + name: this.scenarioDetails.name.value, + title: this.scenarioDetails.name.value, + id: ScenarioReport.idGenerator.generateFrom(this.scenarioDetails.category, this.scenarioDetails.name), + manual: false, + testSteps: [], + get children() { + // fake reference to make the report and the test step interfaces compatible + // removed in 'toJSON' + return this.testSteps; + }, + userStory: { + id: ScenarioReport.idGenerator.generateFrom(this.scenarioDetails.category), + storyName: this.scenarioDetails.category.value, + path: this.scenarioDetails.location.path.value, + type: 'feature', + }, + }; + + this.activities.push(this.report); + } + + sceneStartedAt(time: Timestamp): ScenarioReport { + return this.withMutated(report => { + report.startTime = time.toMillisecondTimestamp(); + }); + } + + executedBy(testRunner: TestRunnerType): ScenarioReport { + return this.withMutated(report => { + report.testSource = testRunner.value; + }); + } + + sceneTaggedWith(tag: Tag) { + return this.withMutated(report => { + if (! report.tags) { + report.tags = []; + } + + report.tags.push(tag.toJSON()); + + match(tag) + .when(ManualTag, _ => report.manual = true) + .when(FeatureTag, _ => report.featureTag = tag.toJSON()) + .when(IssueTag, _ => (report.issues = report.issues || []).push(tag.name)) + .when(BrowserTag, _ => (report.context = report.context || tag.name)) + .when(ContextTag, _ => (report.context = tag.name)) + .else(_ => void 0); + }); + } + + sceneFinishedAt(time: Timestamp): ScenarioReport { + return this.withMutated(report => { + report.duration = Timestamp.fromMillisecondTimestamp(report.startTime).diff(time).milliseconds; + }); + } + + activityBegan(activity: ActivityDetails, time: Timestamp) { + return this.withMutated(report => { + const activityReport: Partial = { + description: activity.name.value, + startTime: time.toMillisecondTimestamp(), + children: [], + screenshots: [], + }; + + this.activities.mostRecentlyAccessedItem().children.push(activityReport as any); + this.activities.push(activityReport); + }); + } + + photoTaken(name: Name) { + return this.withMutated(report => { + this.activities.mostRecentlyAccessedItem().screenshots.push({ screenshot: name.value }); + }); + } + + activityFinished(value: ActivityDetails, outcome: Outcome, time: Timestamp) { + return this.withMutated(report => this.mapOutcome(outcome, (result: string, error?: ErrorDetails) => { + + const activityReport = this.activities.pop(); + + activityReport.result = result; + activityReport.exception = error; + activityReport.duration = Timestamp.fromMillisecondTimestamp(activityReport.startTime).diff(time).milliseconds; + })); + } + + executionFinishedWith(outcome: Outcome): ScenarioReport { + return this.withMutated(report => this.mapOutcome(outcome, (result: string, error: ErrorDetails = undefined) => { + report.result = result; + report.testFailureCause = error; + })); + } + + toJSON(): Partial { + const report = this.copyOf(this.report); + + delete report.children; // remove the fake reference + + // todo: optimise the report, remove empty arrays + return report; + } + + private mapOutcome(outcome: Outcome, mapAs: (result: string, error?: ErrorDetails) => void) { + const parse = ScenarioReport.errorParser.parse; + + return match(outcome). + when(ExecutionCompromised, ({ error }: ExecutionCompromised ) => mapAs('COMPROMISED', parse(error))). + when(ErrorOccurred, ({ error }: ErrorOccurred ) => mapAs('ERROR', parse(error))). + when(AssertionFailed, ({ error }: AssertionFailed ) => mapAs('FAILURE', parse(error))). + when(ExecutionSkipped, _ => mapAs('SKIPPED')). + when(ExecutionIgnored, _ => mapAs('IGNORED')). + when(ImplementationPending, _ => mapAs('PENDING')). + else(/* ExecutionSuccessful */ _ => /* ignore */ mapAs('SUCCESS')); + } + + private withMutated(mutate: (copied: Partial) => void): ScenarioReport { + mutate(this.report); + + return this; + } + + private copyOf(json: T): T { + return JSON.parse(JSON.stringify(json)); + } +} + +class Stack { + private readonly items: T[] = []; + private mostRecent: T = undefined; + + push(item: T): T { + this.items.push(item); + this.mostRecent = item; + + return this.mostRecent; + } + + pop() { + const item = this.items.pop(); + this.mostRecent = item; + + return this.mostRecent; + } + + mostRecentlyAccessedItem() { + return this.mostRecent; + } +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/ScenarioReports.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/ScenarioReports.ts new file mode 100644 index 00000000000..bb9367b7b5e --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/ScenarioReports.ts @@ -0,0 +1,40 @@ +import { ScenarioDetails } from '../../../domain'; +import { IDGenerator } from './IDGenerator'; +import { ScenarioReport } from './ScenarioReport'; + +export class ScenarioReports { + private static idGenerator = new IDGenerator(); + private readonly reports: { [entryId: string]: ScenarioReport } = {}; + + for(scenarioDetails: ScenarioDetails): ScenarioReport { + if (! this.alreadyHasAReportFor(scenarioDetails)) { + return this.createReportFor(scenarioDetails); + } + + return this.reportFor(scenarioDetails); + } + + save(scenarioReport: ScenarioReport) { + this.reports[this.correlationIdFor(scenarioReport.scenarioDetails)] = scenarioReport; + } + + private alreadyHasAReportFor(scenarioDetails: ScenarioDetails): boolean { + return !! this.reports[this.correlationIdFor(scenarioDetails)]; + } + + private reportFor(scenarioDetails: ScenarioDetails): ScenarioReport { + return this.reports[this.correlationIdFor(scenarioDetails)]; + } + + private createReportFor(scenarioDetails: ScenarioDetails): ScenarioReport { + return new ScenarioReport(scenarioDetails); + } + + private correlationIdFor(scenarioDetails: ScenarioDetails): string { + return ScenarioReports.idGenerator.generateFrom( + scenarioDetails.category, + scenarioDetails.name, + scenarioDetails.location.path, + ); + } +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema.ts new file mode 100644 index 00000000000..9dcacc8a7fb --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema.ts @@ -0,0 +1,116 @@ +import { JSONObject } from 'tiny-types'; + +// https://github.com/serenity-bdd/serenity-core/tree/50a3b1824001f192da2cdca6326d7525d4dd7f25/serenity-model/src/test/resources +// https://github.com/serenity-bdd/serenity-core/blob/master/serenity-model/src/main/java/net/thucydides/core/model/TestOutcome.java + +export interface SerenityBDDReport extends JSONObject { + name: string; // done [x] + id: string; // done [x] + testSteps: TestStep[]; // todo [ ] + userStory: UserStory; // todo [~] cucumber + // https://github.com/serenity-bdd/serenity-core/blob/c89cd6ee4127738ac88525d29d99537921f34701/ + // serenity-core/src/test/resources/historical-reports/sample-report-4.json + + featureTag: Tag; // done [x] + title: string; // done [x] + description: string; // done [x] + tags: Tag[]; // done [x] + startTime: number; // done [x] + duration: number; // done [x] + projectKey: string; // todo [ ] protractor <- this typically comes from an env variable + sessionId?: string; // todo [ ] protractor <- how is this used? + driver?: string; // todo [ ] protractor 'chrome:jill' <- how is this used? + context?: string; // done [x] + dataTable?: DataTable; // todo [ ] cucumber <- can I use this with mocha? + manual: boolean; // done [x] + issues?: string[]; // done [x] + testSource: string; // done [x] + result: string; // done [x] + testFailureCause?: ErrorDetails; // done [x] + backgroundTitle?: string; // todo [ ] cucumber + backgroundDescription?: string; // todo [ ] cucumber +} + +export interface TestStep extends JSONObject { + number?: number; // todo [ ] + description: string; // done [x] + duration: number; // donw [x] + startTime: number; // done [x] + result: string; // done [x] + children?: TestStep[]; // done [x] + screenshots?: Screenshot[]; // done [x] + reportData?: ReportData; // todo [ ] + restQuery?: RESTQuery; // todo [ ] + exception?: ErrorDetails; // done [X] + // precondition: false; // not needed? +} + +// https://github.com/serenity-bdd/serenity-core/blob/master/serenity-model/src/main/java/net/thucydides/core/model/ReportData.java +export interface ReportData extends JSONObject { + title: string; + contents: string; +} + +/** + * https://github.com/serenity-bdd/serenity-core/blob/master/serenity-model/src/main/java/net/thucydides/core/screenshots/ScreenshotAndHtmlSource.java + */ +export interface Screenshot extends JSONObject { + screenshot: string; + htmlSource?: string; // "htmlSource": "pagesource7953468346968205961.html.txt" +} + +export interface UserStory extends JSONObject { + id: string; // dashified feature name + storyName: string; // feature name + path: string; // relative feature file path + type: string; // 'feature' + narrative?: string; // cucumber narrative, if any +} + +export interface Tag extends JSONObject { + name: string; + type: string; +} + +export interface DataTable extends JSONObject { + headers: string[]; + rows: DataTableRow[]; + predefinedRows: boolean; + dataSetDescriptors: DataTableDataSetDescriptor[]; +} + +export interface DataTableRow extends JSONObject { + values: string[]; + result: string; +} + +export interface DataTableDataSetDescriptor extends JSONObject { + startRow: number; + rowCount: number; + name: string; + description: string; +} + +export interface RESTQuery extends JSONObject { + method: string; + path: string; + content: string; + contentType: string; + requestHeaders: string; + requestCookies: string; + responseHeaders: string; + responseCookies: string; + responseBody: string; + statusCode: number; +} + +export interface ErrorDetails extends JSONObject { + errorType: string; + message: string; + stackTrace: Array<{ + declaringClass: string, + methodName: string, + fileName: string, + lineNumber: number, + }>; +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts new file mode 100644 index 00000000000..c691330abfb --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts @@ -0,0 +1,132 @@ +import { match } from 'tiny-types'; + +import { StageCrewMember, StageManager } from '../..'; +import { + ActivityBegins, + ActivityFinished, + ArtifactGenerated, + DomainEvent, + ExecutionContextPropertyDetected, + Name, + Photo, + ScenarioDetails, + SceneBegins, + SceneFinished, + SceneTagged, + TestRunnerType, +} from '../../../domain'; +import { Artifact, FileType } from '../../../io'; +import { MD5Hash } from './MD5Hash'; +import { ScenarioReport } from './ScenarioReport'; +import { ScenarioReports } from './ScenarioReports'; +import { SerenityBDDReport } from './SerenityBDDJsonSchema'; + +export class SerenityBDDReporter implements StageCrewMember { + private readonly reports: ScenarioReports = new ScenarioReports(); + private currentScenario: Current = new Current(ScenarioDetails); + + private stageManager: StageManager; + + assignTo(stageManager: StageManager) { + this.stageManager = stageManager; + this.stageManager.register(this); + } + + notifyOf = (event: DomainEvent): void => match(event) + .when(SceneBegins, this.handleSceneBegins) + .when(SceneTagged, this.handleSceneTagged) + .when(ActivityBegins, this.handleActivityBegins) + .when(ActivityFinished, this.handleActivityFinished) + .when(SceneFinished, this.handleSceneFinished) + .when(ExecutionContextPropertyDetected, this.handleExecutionContextPropertyDetected) + .when(ArtifactGenerated, this.handleArtifactGenerated) + .else(_ => void 0); + + private handleSceneBegins = (event: SceneBegins): void => { + this.currentScenario.value = event.value; + const report = this.reports.for(this.currentScenario.value) + .sceneStartedAt(event.timestamp); + + this.reports.save(report); + } + + private handleSceneTagged = (event: SceneTagged): void => { + const report = this.reports.for(event.value) + .sceneTaggedWith(event.tag); + + this.reports.save(report); + } + + private handleActivityBegins = (event: ActivityBegins): void => { + const report = this.reports.for(this.currentScenario.value) + .activityBegan(event.value, event.timestamp); + + this.reports.save(report); + } + + private handleActivityFinished = (event: ActivityFinished): void => { + const report = this.reports.for(this.currentScenario.value) + .activityFinished(event.value, event.outcome, event.timestamp); + + this.reports.save(report); + } + + private handleExecutionContextPropertyDetected = (event: ExecutionContextPropertyDetected): void => { + const report = this.reports.for(event.scenarioDetails); + + this.reports.save(match(event.value) + .when(TestRunnerType, (val: TestRunnerType) => report.executedBy(val)) + .else(_ => report), + ); + } + + private handleArtifactGenerated = (event: ArtifactGenerated): void => { + return match(event.artifact.contents) + .when(Photo, _ => { + const report = this.reports.for(this.currentScenario.value) + .photoTaken(event.artifact.name); + + this.reports.save(report); + }) + .else(_ => void 0); + } + + private handleSceneFinished = (event: SceneFinished): void => { + const report = this.reports.for(event.value). + sceneFinishedAt(event.timestamp). + executionFinishedWith(event.outcome); + + this.reports.save(report); + + this.currentScenario.clear(); + + this.broadcast(report.toJSON()); + } + + private broadcast(report: Partial) { + this.stageManager.notifyOf(new ArtifactGenerated( + new Artifact( + new Name(MD5Hash.of(JSON.stringify(report)).value), + FileType.JSON, + report, + ), + )); + } +} + +class Current { + constructor(private readonly type: { new(...args: any[]): T }, private val: T = null) { + } + + set value(value: T) { + this.val = value; + } + + get value() { + return this.val; + } + + clear() { + this.val = null; + } +} diff --git a/packages/core/src/stage/crew/serenity-bdd-reporter/index.ts b/packages/core/src/stage/crew/serenity-bdd-reporter/index.ts new file mode 100644 index 00000000000..a5a0e80130f --- /dev/null +++ b/packages/core/src/stage/crew/serenity-bdd-reporter/index.ts @@ -0,0 +1 @@ +export * from './SerenityBDDReporter'; diff --git a/packages/core/src/stage/index.ts b/packages/core/src/stage/index.ts index 373149b6663..1a5f4cb11d4 100644 --- a/packages/core/src/stage/index.ts +++ b/packages/core/src/stage/index.ts @@ -1,2 +1,5 @@ -export * from './stage' -export * from './stage_manager' +export * from './Clock'; +export * from './crew'; +export * from './Stage'; +export * from './StageCrewMember'; +export * from './StageManager'; diff --git a/packages/core/src/stage/stage.ts b/packages/core/src/stage/stage.ts deleted file mode 100644 index f2eeba7f031..00000000000 --- a/packages/core/src/stage/stage.ts +++ /dev/null @@ -1,49 +0,0 @@ -import { Actor } from '../screenplay/actor'; -import { StageManager } from './stage_manager'; - -/// [cast] -export interface Cast { - actor(name: string): Actor; -} -/// [cast] - -export class Stage { - - private cast: Cast; - private actorInTheSpotlight: Actor; - - constructor(public manager: StageManager) { - } - - enter(cast: Cast) { - this.cast = cast; - - return this; - } - - theActorCalled(actorName: string): Actor { - if (! this.actorsAreReady()) { - throw new Error('The cast has not entered the stage yet.'); - } - - this.actorInTheSpotlight = this.cast.actor(actorName); - - return this.actorInTheSpotlight; - } - - theShowHasStarted(): boolean { - return !! this.actorInTheSpotlight; - } - - theActorInTheSpotlight(): Actor { - if (! this.theShowHasStarted()) { - throw new Error('There\'s no actor in the spotlight yet.'); - } - - return this.actorInTheSpotlight; - } - - actorsAreReady(): boolean { - return !! this.cast; - } -} diff --git a/packages/core/src/stage/stage_manager.ts b/packages/core/src/stage/stage_manager.ts deleted file mode 100644 index ea4cbda106d..00000000000 --- a/packages/core/src/stage/stage_manager.ts +++ /dev/null @@ -1,114 +0,0 @@ -import * as _ from 'lodash'; - -import {DomainEvent} from '../domain/events'; -import { Stage } from './stage'; - -export interface StageCrewMember { - assignTo(stage: Stage); - - notifyOf(event: DomainEvent): void; -} - -export class StageManager { - - private listeners: CrewMembersCommunicationChannel[] = []; - private wip: Array> = []; - - constructor(private journal: Journal) { - } - - notifyOf(event: DomainEvent) { - this.journal.record(event); - - if (this.listeners[event.constructor.name]) { - this.listeners[event.constructor.name].notify(event); - } - - // for the "catch-all" crew members - if (this.listeners[DomainEvent.name]) { - this.listeners[DomainEvent.name].notify(event); - } - } - - informOfWorkInProgress(promise: PromiseLike): PromiseLike { - this.wip.push(promise); - - return promise; - } - - /** - * Returns a promise that resolves when there's no more "work in progress", - * so all the screenshots are saved, the browser is restarted and so on. - */ - waitForNextCue = (): PromiseLike => Promise.all(this.wip); - - registerInterestIn(eventsOfInterest: Array, crewMember: StageCrewMember) { - - eventsOfInterest.forEach(eventType => { - - if (! this.listeners[eventType.name]) { - this.listeners[eventType.name] = new CrewMembersCommunicationChannel(); - } - - this.listeners[eventType.name].register(crewMember); - }); - } - - readTheJournal(): Array> { - return this.journal.read(); - } - - readNewJournalEntriesAs(readerId: string): Array> { - return this.journal.readAs(readerId); - } -} - -export class Journal { - private events: Array> = []; - private bookmarks: { [id: string]: number } = {}; - - /** - * Records an event and stores it in memory - * - * @param event - */ - public record(event: DomainEvent) { - this.events.push(event); - } - - /** - * Returns a list of all the events ever recorded - * - * @return {Event[]} a list of events - */ - public read(): Array> { - return _.sortBy(_.cloneDeep(this.events), event => event.timestamp ); - } - - /** - * Returns a list of all the events recorded since you last checked - * - * @return {Event[]} a list of events - */ - public readAs(readerId: string): Array> { - const - events = this.read(), - bookmark = this.bookmarks[readerId] || 0; - - this.bookmarks[readerId] = events.length; - - return events.slice(bookmark); - } -} - -class CrewMembersCommunicationChannel { - private listeners: StageCrewMember[] = []; - - register(listener: StageCrewMember) { - this.listeners.push(listener); - } - - notify(event: DomainEvent) { - this.listeners.forEach(listener => listener.notifyOf(_.cloneDeep(event)) ); - } -} diff --git a/packages/cucumber-2/.gitignore b/packages/cucumber-2/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/packages/cucumber-2/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/packages/cucumber-2/.npmignore b/packages/cucumber-2/.npmignore deleted file mode 100644 index 5ba40baf96e..00000000000 --- a/packages/cucumber-2/.npmignore +++ /dev/null @@ -1,17 +0,0 @@ -# Node -node_modules -*.log -.npmignore -npm-shrinkwrap.json - -# Build artifacts -.nyc_output -staging -target - -# Specs -spec -features -mocha.opts -tsconfig*.json -tslint.json diff --git a/packages/cucumber-2/LICENSE.md b/packages/cucumber-2/LICENSE.md deleted file mode 100644 index 9c8f3ea0871..00000000000 --- a/packages/cucumber-2/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - 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. \ No newline at end of file diff --git a/packages/cucumber-2/NOTICE.md b/packages/cucumber-2/NOTICE.md deleted file mode 100644 index 24c0543b6ba..00000000000 --- a/packages/cucumber-2/NOTICE.md +++ /dev/null @@ -1 +0,0 @@ -Copyright 2016- Jan Molak, smartcode ltd. diff --git a/packages/cucumber-2/README.md b/packages/cucumber-2/README.md deleted file mode 100644 index 6626fccba68..00000000000 --- a/packages/cucumber-2/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Serenity/JS - -Serenity/JS is a node.js library designed to make acceptance and regression testing of modern web applications -faster, more collaborative and easier to scale. - -Find out more at [serenity-js.org](http://serenity-js.org)! diff --git a/packages/cucumber-2/features/recognises_a_failing_scenario.feature b/packages/cucumber-2/features/recognises_a_failing_scenario.feature deleted file mode 100644 index 2e6e0601ff8..00000000000 --- a/packages/cucumber-2/features/recognises_a_failing_scenario.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises a failing scenario - - Scenario: A failing scenario with a synchronous interface - Given a step that fails with a synchronous interface - - Scenario: A failing scenario with a callback interface - Given a step that fails with a callback interface - - Scenario: A failing scenario with a promise interface - Given a step that fails with a promise interface diff --git a/packages/cucumber-2/features/recognises_a_passing_scenario.feature b/packages/cucumber-2/features/recognises_a_passing_scenario.feature deleted file mode 100644 index 7a226b5cb42..00000000000 --- a/packages/cucumber-2/features/recognises_a_passing_scenario.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises a passing scenario - - Scenario: A passing scenario with a synchronous interface - Given a step that passes with a synchronous interface - - Scenario: A passing scenario with a callback interface - Given a step that passes with a callback interface - - Scenario: A passing scenario with a promise interface - Given a step that passes with a promise interface diff --git a/packages/cucumber-2/features/recognises_a_skipped_scenario.feature b/packages/cucumber-2/features/recognises_a_skipped_scenario.feature deleted file mode 100644 index 1e2f9a697c8..00000000000 --- a/packages/cucumber-2/features/recognises_a_skipped_scenario.feature +++ /dev/null @@ -1,5 +0,0 @@ -Feature: Recognises a skipped scenario - - @wip - Scenario: A skipped scenario - Given a scenario that is never executed \ No newline at end of file diff --git a/packages/cucumber-2/features/recognises_an_explicitly_pending_scenario.feature b/packages/cucumber-2/features/recognises_an_explicitly_pending_scenario.feature deleted file mode 100644 index fad4890f881..00000000000 --- a/packages/cucumber-2/features/recognises_an_explicitly_pending_scenario.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises explicitly pending scenarios - - Scenario: An explicitly pending synchronous scenario - Given a pending step with a synchronous interface - - Scenario: An explicitly pending callback scenario - Given a pending step with a callback interface - - Scenario: An explicitly pending promise scenario - Given a pending step with a promise interface \ No newline at end of file diff --git a/packages/cucumber-2/features/recognises_an_implicitly_pending_scenario.feature b/packages/cucumber-2/features/recognises_an_implicitly_pending_scenario.feature deleted file mode 100644 index 846660836b6..00000000000 --- a/packages/cucumber-2/features/recognises_an_implicitly_pending_scenario.feature +++ /dev/null @@ -1,4 +0,0 @@ -Feature: Recognises an implicitly pending scenario - - Scenario: An implicitly pending scenario - Given a scenario with no defined steps diff --git a/packages/cucumber-2/features/recognises_multi_value_tags.feature b/packages/cucumber-2/features/recognises_multi_value_tags.feature deleted file mode 100644 index a52fb32b10b..00000000000 --- a/packages/cucumber-2/features/recognises_multi_value_tags.feature +++ /dev/null @@ -1,6 +0,0 @@ -@cucumber -Feature: Recognises scenario tags - - @regression @issues:MY-PROJECT-123,MY-PROJECT-789 - Scenario: A regression test covering two issues - Given a step that passes \ No newline at end of file diff --git a/packages/cucumber-2/features/recognises_single_value_tags.feature b/packages/cucumber-2/features/recognises_single_value_tags.feature deleted file mode 100644 index 0ded436bd2b..00000000000 --- a/packages/cucumber-2/features/recognises_single_value_tags.feature +++ /dev/null @@ -1,6 +0,0 @@ -@cucumber -Feature: Recognises scenario tags - - @regression @issue:MY-PROJECT-123 - Scenario: A regression test covering one issue - Given a step that passes diff --git a/packages/cucumber-2/features/recognises_special_step_arguments.feature b/packages/cucumber-2/features/recognises_special_step_arguments.feature deleted file mode 100644 index 4618a1c54b5..00000000000 --- a/packages/cucumber-2/features/recognises_special_step_arguments.feature +++ /dev/null @@ -1,19 +0,0 @@ -Feature: Recognises special step arguments - - # https://github.com/cucumber/cucumber-js/blob/b659dc887ee8e94149b2148e83857b6c653aa2fa/features/data_tables.feature - @datatable - Scenario: Reports a data table argument - - Given the following accounts: - | name | email | twitter | - | Jan | jan.molak@serenity.io | @JanMolak | - | John | john.smart@serenity.io | @wakaleo | - - @docstring - Scenario: Reports a DocString argument - - Given an example.ts file with the following contents: - """ - export const noop = (_) => _; - export const sum = (a, b) => a + b; - """ \ No newline at end of file diff --git a/packages/cucumber-2/features/recognises_tests_that_timed_out.feature b/packages/cucumber-2/features/recognises_tests_that_timed_out.feature deleted file mode 100644 index 41717880a34..00000000000 --- a/packages/cucumber-2/features/recognises_tests_that_timed_out.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises a failing scenario - - Scenario Outline: A scenario with a step that times out - Given a slow, step - - Examples: - | TYPE | - | callback | - | promise | - | generator | \ No newline at end of file diff --git a/packages/cucumber-2/features/step_definitions/steps.ts b/packages/cucumber-2/features/step_definitions/steps.ts deleted file mode 100644 index d27797c4e4b..00000000000 --- a/packages/cucumber-2/features/step_definitions/steps.ts +++ /dev/null @@ -1,115 +0,0 @@ -import { defineSupportCode } from 'cucumber'; - -enum StepInterface { - SYNCHRONOUS, - CALLBACK, - PROMISE, -} - -enum StepResult { - SUCCESS, - FAILURE, - PENDING, -} - -function createFailingStep(stepInterface: StepInterface) { - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - process.nextTick(cb.bind(null, new Error('Assertion failed'))); - }; - case StepInterface.PROMISE: - return () => { - return new Promise((resolve, reject) => { - process.nextTick(() => { - reject(new Error('Assertion failed')); - }); - }); - }; - case StepInterface.SYNCHRONOUS: - default: - return () => { - throw new Error('Assertion failed'); - }; - } -} - -function createPassingStep(stepInterface: StepInterface, result: StepResult) { - const resultValue = StepResult[ result ].toLowerCase(); - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - process.nextTick(cb.bind(null, null, resultValue)); - }; - case StepInterface.PROMISE: - return () => { - return new Promise(resolve => process.nextTick(() => resolve(resultValue))); - }; - case StepInterface.SYNCHRONOUS: - default: - return () => { - return resultValue; - }; - } -} - -function createSlowStep(stepInterface: StepInterface, timeout: number) { - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - setTimeout(cb, timeout); - }; - case StepInterface.PROMISE: - default: - return () => { - return new Promise(resolve => setTimeout(resolve, timeout)); - }; - } -} - -function createStep(stepInterface: StepInterface, result: StepResult) { - if (result === StepResult.FAILURE) { - return createFailingStep(stepInterface); - } - return createPassingStep(stepInterface, result); -} - -defineSupportCode(({ Given }) => { - - Given(/^a step that passes$/, - createStep(StepInterface.PROMISE, StepResult.SUCCESS)); - - Given(/^a step that passes with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.SUCCESS)); - - Given(/^a step that passes with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.SUCCESS)); - - Given(/^a step that passes with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.SUCCESS)); - - Given(/^a step that fails with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.FAILURE)); - - Given(/^a step that fails with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.FAILURE)); - - Given(/^a step that fails with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.FAILURE)); - - Given(/^a pending step with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.PENDING)); - - Given(/^a pending step with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.PENDING)); - - Given(/^a pending step with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.PENDING)); - - Given(/^the following.*$/, data => Promise.resolve()); - - Given(/^an example.ts file with the following contents:$/, docstring => Promise.resolve()); - - Given(/^a slow, callback step$/, { timeout: 100 }, createSlowStep(StepInterface.CALLBACK, 10000)); - Given(/^a slow, promise step$/, { timeout: 100 }, createSlowStep(StepInterface.PROMISE, 10000)); -}); diff --git a/packages/cucumber-2/package.json b/packages/cucumber-2/package.json deleted file mode 100644 index 2aa770d0983..00000000000 --- a/packages/cucumber-2/package.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "name": "@serenity-js/cucumber-2", - "version": "1.4.0", - "description": "Enables Serenity/JS to run Cucumber 2 test scenarios", - "author": "Jan Molak ", - "homepage": "http://serenity-js.org", - "license": "Apache-2.0", - "config": { - "access": "public" - }, - "main": "lib/index.js", - "typings": "lib/index.d.ts", - "keywords": [ - "serenity-js", - "cucumber", - "tdd", - "bdd", - "test", - "selenium", - "webdriverjs", - "webdriver", - "testing" - ], - "scripts": { - "clean": "rimraf lib", - "lint": "tslint --project tsconfig.json --config ../../tslint.json --format stylish", - "test": "nyc --report-dir ../../target/coverage/cucumber-2 mocha --opts ../../mocha.opts 'spec/**/*.spec.*'", - "package": "tsc --project tsconfig.json", - "verify": "npm run clean && npm run lint && npm test && npm run package" - }, - "repository": { - "type": "git", - "url": "https://github.com/jan-molak/serenity-js.git" - }, - "bugs": { - "url": "https://github.com/jan-molak/serenity-js/issues" - }, - "engines": { - "node": ">= 6.9.x", - "npm": ">= 3" - }, - "peerDependencies": { - "cucumber": "2.0.0-rc.9" - }, - "devDependencies": { - "@types/cucumber": "2.0.0", - "@types/glob": "5.0.30", - "@types/lodash": "4.14.55", - "cucumber": "2.0.0-rc.9" - }, - "dependencies": { - "@serenity-js/core": "^1.1.0", - "glob": "7.1.1", - "lodash": "4.17.4" - }, - "nyc": { - "include": [ - "src/*.ts", - "src/**/*.ts" - ], - "exclude": [ - "features", - "lib", - "node_modules", - "spec", - "staging" - ], - "extension": [ - ".ts" - ], - "require": [ - "ts-node/register" - ], - "reporter": [ - "json", - "text-summary", - "html" - ], - "cache": true, - "all": true - } -} diff --git a/packages/cucumber-2/register.js b/packages/cucumber-2/register.js deleted file mode 100644 index ef791a7611c..00000000000 --- a/packages/cucumber-2/register.js +++ /dev/null @@ -1 +0,0 @@ -require('./lib/register'); diff --git a/packages/cucumber-2/spec/adapted-cucumber/adapter.ts b/packages/cucumber-2/spec/adapted-cucumber/adapter.ts deleted file mode 100644 index 10bc907815a..00000000000 --- a/packages/cucumber-2/spec/adapted-cucumber/adapter.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { serenity } from '@serenity-js/core'; -import { ChildProcessReporter } from '../spawner/child_process_reporter'; - -import path = require('path'); -import _ = require('lodash'); - -serenity.configure({ - crew: [new ChildProcessReporter()] -}); - -export = parsed => require(__dirname + '/../../src/index.ts')({ // tslint:disable-line:no-var-requires - cwd: path.resolve(__dirname, '..', '..'), - parameters: _(parsed.options).omitBy(_.isUndefined).omit('version').value(), -}). -run(_(parsed.args).without('').value()). -then(() => { - process.exit(0); -}, e => { - console.error(e); - process.exit(1); -}); diff --git a/packages/cucumber-2/spec/adapted-cucumber/index.js b/packages/cucumber-2/spec/adapted-cucumber/index.js deleted file mode 100644 index 78acba01d98..00000000000 --- a/packages/cucumber-2/spec/adapted-cucumber/index.js +++ /dev/null @@ -1,6 +0,0 @@ -const ArgvParser = require('cucumber/lib/cli/argv_parser'); -const parsed = ArgvParser.default.parse(process.argv); - -require('ts-node/register'); - -require('./adapter.ts')(parsed); diff --git a/packages/cucumber-2/spec/cucumber_adapter.spec.ts b/packages/cucumber-2/spec/cucumber_adapter.spec.ts deleted file mode 100644 index 8e58b3e0428..00000000000 --- a/packages/cucumber-2/spec/cucumber_adapter.spec.ts +++ /dev/null @@ -1,115 +0,0 @@ -import { Result } from '@serenity-js/core/lib/domain'; - -import { given } from 'mocha-testdata'; -import { CucumberAdapter } from '../src/cucumber_adapter'; -import { spawner } from './spawner/spawner'; -import path = require('path'); - -import chai = require('chai'); -import chaiAsPromised = require('chai-as-promised'); -chai.use(chaiAsPromised); - -const expect = chai.expect; - -describe('cucumber-2', () => { - describe('CucumberAdapter', function() { - - this.timeout(30 * 1000); - - const cucumber = (spec: string, scenario: string, ...options: string[]) => spawner('./adapted-cucumber', { - cwd: __dirname, - silent: true, - } )( - '--name', scenario, - '--require', 'features/step_definitions/steps.ts', - ...options, - spec, - ); - - given( - [ 'A passing scenario with a synchronous interface', 'Given a step that passes with a synchronous interface'], - [ 'A passing scenario with a callback interface', 'Given a step that passes with a callback interface' ], - [ 'A passing scenario with a promise interface', 'Given a step that passes with a promise interface' ], - ). - it('reports passing scenarios', (scenario: string, step: string) => { - const spawned = cucumber('features/*passing_scenario.feature', scenario); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(4); - - expect(spawned.messages[0].value.name).to.equal(scenario); - expect(spawned.messages[1].value.name).to.equal(step); - expect(spawned.messages[2].value.subject.name).to.equal(step); - expect(spawned.messages[3].value.subject.name).to.equal(scenario); - }); - }); - - it ('ignores skipped scenarios', () => { - const spawned = cucumber('features/*skipped_scenario.feature', 'A skipped scenario', '--tags', 'not @wip'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(0); - }); - }); - - it ('reports implicitly pending scenarios', () => { - const scenario = 'An implicitly pending scenario', - step = 'Given a scenario with no defined steps'; - - const spawned = cucumber('**/*implicitly_pending_scenario.feature', scenario, '--no-strict'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(4); - - expect(spawned.messages[0].value.name).to.equal(scenario); - expect(spawned.messages[1].value.name).to.equal(step); - expect(spawned.messages[2].value.subject.name).to.equal(step); - expect(Result[spawned.messages[3].value.result]).to.equal(Result[Result.PENDING]); - expect(spawned.messages[3].value.subject.name).to.equal(scenario); - expect(Result[spawned.messages[3].value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - given( - [ 'An explicitly pending synchronous scenario', 'Given a pending step with a synchronous interface'], - [ 'An explicitly pending callback scenario', 'Given a pending step with a callback interface' ], - [ 'An explicitly pending promise scenario', 'Given a pending step with a promise interface' ], - ). - it ('reports explicitly pending scenarios', (scenario: string, step: string) => { - const spawned = cucumber('**/*explicitly_pending_scenario.feature', scenario, '--no-strict'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(4); - - expect(spawned.messages[0].value.name).to.equal(scenario); - expect(spawned.messages[1].value.name).to.equal(step); - expect(spawned.messages[2].value.subject.name).to.equal(step); - expect(Result[spawned.messages[3].value.result]).to.equal(Result[Result.PENDING]); - expect(spawned.messages[3].value.subject.name).to.equal(scenario); - expect(Result[spawned.messages[3].value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - given( - [ 'A failing scenario with a synchronous interface', 'Given a step that fails with a synchronous interface'], - [ 'A failing scenario with a callback interface', 'Given a step that fails with a callback interface' ], - [ 'A failing scenario with a promise interface', 'Given a step that fails with a promise interface' ], - ). - it('reports failing scenarios', (scenario: string, step: string) => { - const spawned = cucumber('**/*failing_scenario.feature', scenario); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(4); - - expect(spawned.messages).to.have.lengthOf(4); - - expect(spawned.messages[0].value.name).to.equal(scenario); - expect(spawned.messages[1].value.name).to.equal(step); - expect(spawned.messages[2].value.subject.name).to.equal(step); - expect(Result[spawned.messages[3].value.result]).to.equal(Result[Result.FAILURE]); - expect(spawned.messages[3].value.subject.name).to.equal(scenario); - expect(Result[spawned.messages[3].value.result]).to.equal(Result[Result.FAILURE]); - }); - }); - }); -}); diff --git a/packages/cucumber-2/spec/expect.ts b/packages/cucumber-2/spec/expect.ts deleted file mode 100644 index b32b1d1caec..00000000000 --- a/packages/cucumber-2/spec/expect.ts +++ /dev/null @@ -1,8 +0,0 @@ -import chai = require('chai'); -import sinonChai = require('sinon-chai'); -import chaiAsPromised = require('chai-as-promised'); - -chai.use(sinonChai); -chai.use(chaiAsPromised); - -export const expect = chai.expect; diff --git a/packages/cucumber-2/spec/spawner/child_process_reporter.ts b/packages/cucumber-2/spec/spawner/child_process_reporter.ts deleted file mode 100644 index e1d6a10a9b4..00000000000 --- a/packages/cucumber-2/spec/spawner/child_process_reporter.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { DomainEvent } from '@serenity-js/core/lib/domain'; -import { StageCrewMember } from '@serenity-js/core/lib/stage'; - -export class ChildProcessReporter implements StageCrewMember { - constructor() { - this.enableSerialisationOfErrors(); - } - - assignTo(stage) { - stage.manager.registerInterestIn([ DomainEvent ], this); - } - - notifyOf(event) { - process.send(event); - } - - private enableSerialisationOfErrors() { - if (! ('toJSON' in Error.prototype)) { - Object.defineProperty(Error.prototype, 'toJSON', { - value: function() { // tslint:disable-line:object-literal-shorthand needed for `this` to work - const alt = {}; - - Object.getOwnPropertyNames(this).forEach(function(key) { - alt[key] = this[key]; - }, this); - - return alt; - }, - configurable: true, - writable: true, - }); - } - } -} - -export function childProcessReporter() { - return new ChildProcessReporter(); -} diff --git a/packages/cucumber-2/spec/spawner/spawner.ts b/packages/cucumber-2/spec/spawner/spawner.ts deleted file mode 100644 index bff9419aff8..00000000000 --- a/packages/cucumber-2/spec/spawner/spawner.ts +++ /dev/null @@ -1,73 +0,0 @@ -import { - ActivityFinished, - ActivityStarts, - DomainEvent, - Outcome, - RecordedActivity, - RecordedScene, - SceneFinished, - SceneStarts, - Tag, -} from '@serenity-js/core/lib/domain'; - -import { ForkOptions } from 'child_process'; - -import childProcess = require('child_process'); - -export class Spawned { - messages: any[] = []; - result: PromiseLike; - - constructor(pathToScript: string, args: string[], options: ForkOptions) { - - const spawned = childProcess.fork(pathToScript, args, options); - - spawned.on('message', event => this.messages.push(deserialised(event))); - - this.result = new Promise( (resolve, reject) => { - spawned.on('close', exitCode => { - if (exitCode !== 0) { - reject(exitCode); - } else { - resolve(0); - } - }); - }); - } -} - -function deserialised(event: any): DomainEvent { - const tagsFrom = (tags: Tag[]) => tags.map(_ => new Tag(_.type, _.values)), - scene = ({ name, category, location, tags, id }: RecordedScene): RecordedScene => new RecordedScene(name, category, location, tagsFrom(tags), id), - activity = ({ name, location, id }: RecordedActivity): RecordedActivity => new RecordedActivity(name, location, id), - outcome = (type: (T) => T, { subject, result, error }: Outcome) => new Outcome(type(subject), result, error); - - switch (event.type) { - case 'SceneStarts': - return new SceneStarts( - scene(event.value), - event.timestamp, - ); - case 'ActivityStarts': - return new ActivityStarts( - activity(event.value), - event.timestamp, - ); - case 'ActivityFinished': - return new ActivityFinished( - outcome(activity, event.value), - event.timestamp, - ); - case 'SceneFinished': - return new SceneFinished( - outcome(scene, event.value), - event.timestamp, - ); - default: - return event; - } -} - -export function spawner(pathToScript: string, options?: ForkOptions) { - return (...args: string[]) => new Spawned(pathToScript, args, options); -}; diff --git a/packages/cucumber-2/src/cucumber_adapter.ts b/packages/cucumber-2/src/cucumber_adapter.ts deleted file mode 100644 index 822d8871748..00000000000 --- a/packages/cucumber-2/src/cucumber_adapter.ts +++ /dev/null @@ -1,52 +0,0 @@ -import { SerenityConfig } from '@serenity-js/core'; -import { TestFrameworkAdapter } from '@serenity-js/core/lib/integration'; - -import { CucumberOptions } from './cucumber_options'; - -import _ = require('lodash'); -import glob = require('glob'); -import path = require('path'); - -const Cucumber = require('cucumber'); // tslint:disable-line:no-var-requires - -export class CucumberAdapter implements TestFrameworkAdapter { - - private argv: string[] = []; - - constructor(private config: SerenityConfig) { - this.argv = [ 'node', 'cucumberjs' ] - .concat([ '--require', this.notifier() ]) - .concat([ '--require', this.stageCue() ]) - .concat(this.argumentsFrom(config)); - } - - run = (specs: string[]): PromiseLike => new Cucumber.Cli({ - argv: this.argv.concat(this.resolved(specs)), - cwd: this.config.cwd, - stdout: process.stdout, - }).run().then(this.booleanToPromise) - - private notifier = () => glob.sync(path.resolve(__dirname) + '/register.?s').pop(); - private stageCue = () => glob.sync(path.resolve(__dirname) + '/stage_cue.?s').pop(); - - private booleanToPromise = (result: boolean) => result ? Promise.resolve(result) : Promise.reject(result); - - private argumentsFrom(config: SerenityConfig): string[] { - const resolvedConfig = Object.assign({}, config.parameters, { require: this.resolved(config.parameters.require || []) }); - - const toCLIArgument = option => (value: string) => !! value - ? [ `--${ option }`, value ] - : [ `--no-${ option }` ]; - - return _.chain(resolvedConfig).toPairs(). - flatMap(option => _.castArray(option[ 1 ]).map(toCLIArgument(option[0]))). - flatten(). - value() as string[]; - } - - private resolved(paths: string[]): string[] { - const resolveGlobs = (path: string) => glob.sync(path, { cwd: this.config.cwd }); - - return _.chain(paths).map(resolveGlobs).flatten().value() as string[]; - } -} diff --git a/packages/cucumber-2/src/cucumber_options.ts b/packages/cucumber-2/src/cucumber_options.ts deleted file mode 100644 index 2f233872804..00000000000 --- a/packages/cucumber-2/src/cucumber_options.ts +++ /dev/null @@ -1,52 +0,0 @@ -/** - * @see {@link https://github.com/cucumber/cucumber-js/blob/2d7c2523ddd88153a45d86f0e0f2a50c16814d1f/src/cli/argv_parser.js#L27} - */ -export interface CucumberOptions { - failFast?: boolean; - - backtrace?: boolean; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#transpilers - */ - compiler?: string; - - dryRun?: boolean; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#formats - */ - format?: string; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#format-options - */ - formatOptions?: string; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#running-specific-features - */ - name?: string[]; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#profiles - */ - profile?: string[]; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#requiring-support-files - */ - require?: string[]; - - strict?: boolean; - - /** - * @link https://docs.cucumber.io/tag-expressions/ - */ - tags?: string; - - /** - * @link https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#world-parameters - */ - worldParameters?: string; -} diff --git a/packages/cucumber-2/src/index.ts b/packages/cucumber-2/src/index.ts deleted file mode 100644 index 91169524183..00000000000 --- a/packages/cucumber-2/src/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { SerenityConfig } from '@serenity-js/core'; -import { CucumberAdapter } from './cucumber_adapter'; -import { CucumberOptions } from './cucumber_options'; - -export = (config: SerenityConfig) => new CucumberAdapter(config); diff --git a/packages/cucumber-2/src/model.ts b/packages/cucumber-2/src/model.ts deleted file mode 100644 index 937e1d886bc..00000000000 --- a/packages/cucumber-2/src/model.ts +++ /dev/null @@ -1,53 +0,0 @@ -export interface Tag { - name: string; -} - -export interface Feature { - name: string; -} - -export interface Scenario { - feature: Feature; - line: number; - name: string; - tags: Tag[]; - uri: string; -} - -export interface Step { - keyword: string; - name: string; - isHidden: boolean; - arguments: StepArgument[]; -} - -export type StepArgument = DataTable | DocString; - -export interface DataTable { - hashes(): any; - raw(): any; - rows(): any[]; - rowsHash(): any; -} - -export interface DocString { - content: string; - contentType: string; - line: number; -} - -export type Status = 'ambiguous' | 'failed' | 'passed' | 'pending' | 'skipped' | 'undefined'; - -export interface StepResult { - status: Status; - step: Step; - failureException?: FailureException; -} - -export interface ScenarioResult { - status: Status; - scenario: Scenario; - failureException?: FailureException; -} - -export type FailureException = Error | string; diff --git a/packages/cucumber-2/src/notifier.ts b/packages/cucumber-2/src/notifier.ts deleted file mode 100644 index 3242b1a1bd5..00000000000 --- a/packages/cucumber-2/src/notifier.ts +++ /dev/null @@ -1,114 +0,0 @@ -import { serenity } from '@serenity-js/core'; -import { ActivityFinished, ActivityStarts, Outcome, RecordedActivity, RecordedScene, Result, SceneFinished, SceneStarts, Tag } from '@serenity-js/core/lib/domain'; -import { DataTable, DocString, FailureException, Scenario, ScenarioResult, Step, StepArgument, StepResult } from './model'; - -const CucumberStep = require('cucumber/lib/models/step').default; // tslint:disable-line:no-var-requires - -export class Notifier { - handleBeforeScenario = (scenario: Scenario) => - serenity.notify(new SceneStarts(CucumberScene.from(scenario))); - - handleBeforeStep = (step: Step) => - this.isOfInterest(step) && serenity.notify(new ActivityStarts(CucumberTask.from(step))); - - handleStepResult = (result: StepResult) => - this.isOfInterest(result.step) && serenity.notify(new ActivityFinished(CucumberOutcome.fromStep(result))); - - handleScenarioResult = (result: ScenarioResult) => - serenity.notify(new SceneFinished(CucumberOutcome.fromScenario(result))); - - /** - * "Before hooks" will also trigger the listeners, but we don't want to report on them - * https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/event_handlers.md - * @param step - */ - private isOfInterest = (step: any) => step instanceof CucumberStep && ! step.isHidden; - -} - -class CucumberOutcome extends Outcome { - - static fromStep = (result: StepResult) => new CucumberOutcome( - CucumberTask.from(result.step), - CucumberResult.from(result), - realErrorFrom(result.failureException), - ); - - static fromScenario = (result: ScenarioResult) => new CucumberOutcome( - CucumberScene.from(result.scenario), - CucumberResult.from(result), - realErrorFrom(result.failureException), - ); - - constructor(subject: T, result: Result, error: Error) { - super(subject, result, error); - } -} - -function realErrorFrom(pseudoError: FailureException): Error | undefined { - switch (typeof pseudoError) { - case 'string': return new Error(pseudoError as string); - case 'object': return pseudoError as Error; - default: return undefined; - } -} - -class CucumberResult { - static from = (result: StepResult | ScenarioResult) => { - const isTimeOut = (e: Error) => e && /timed out/.test(e.message); - - const results = { - undefined: Result.PENDING, - failed: Result.FAILURE, - pending: Result.PENDING, - passed: Result.SUCCESS, - skipped: Result.SKIPPED, - }; - - if (!results[ result.status ]) { - throw new Error(`Couldn't map the '${ result.status }' to a Serenity Result`); - } - - return isTimeOut(realErrorFrom(result.failureException)) - ? Result.ERROR - : results[ result.status ]; - } -} - -class CucumberScene extends RecordedScene { - static from = (scenario: Scenario) => new CucumberScene(scenario); - - constructor(scenario: Scenario) { - super( - scenario.name, - scenario.feature.name, - { path: scenario.uri, line: scenario.line }, - scenario.tags.map(tag => Tag.from(tag.name)), - `${ scenario.feature.name }:${ scenario.line }:${ scenario.name }`, - ); - } -} - -class CucumberTask extends RecordedActivity { - static from = (step: Step) => new CucumberTask(step); - - private static fullNameOf = (step: Step): string => [ - step.keyword, - step.name, - step.arguments.map(argument => SerialisedStepArgument.from(argument)).join('\n'), - ].join('').trim(); - - constructor(step: Step) { - super(CucumberTask.fullNameOf(step)); - } - -} - -class SerialisedStepArgument { - static from = (argument: StepArgument) => { - switch (argument.constructor.name) { // tslint:disable-line:switch-default - case 'DataTable': return `\n${ (argument as DataTable).raw().map(row => `| ${ row.join(' | ') } |`).join('\n') }`; - case 'DocString': return `\n${ (argument as DocString).content }`; - } - } -} diff --git a/packages/cucumber-2/src/register.ts b/packages/cucumber-2/src/register.ts deleted file mode 100644 index 490e11f5e0c..00000000000 --- a/packages/cucumber-2/src/register.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { defineSupportCode } from 'cucumber'; -import { Notifier } from './notifier'; - -defineSupportCode(({ registerListener }) => { - - registerListener(new Notifier() as any); -}); diff --git a/packages/cucumber-2/src/stage_cue.ts b/packages/cucumber-2/src/stage_cue.ts deleted file mode 100644 index 2246ed78f52..00000000000 --- a/packages/cucumber-2/src/stage_cue.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { serenity } from '@serenity-js/core'; -import { defineSupportCode } from 'cucumber'; - -// wait for any tasks outstanding after the previous scenario -// see https://github.com/angular/protractor/issues/4087 - -defineSupportCode(({ Before, After }) => { - Before({ timeout: serenity.config.stageCueTimeout }, () => serenity.stageManager().waitForNextCue()); -}); diff --git a/packages/cucumber-2/tsconfig.json b/packages/cucumber-2/tsconfig.json deleted file mode 100644 index 422e9cd214c..00000000000 --- a/packages/cucumber-2/tsconfig.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true, - "outDir": "./lib" - }, - - "include": [ - "src/**/*.ts" - ], - "exclude": [ - "features", - "spec", - "node_modules" - ] -} \ No newline at end of file diff --git a/packages/cucumber/.gitignore b/packages/cucumber/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/packages/cucumber/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/packages/cucumber/.npmignore b/packages/cucumber/.npmignore deleted file mode 100644 index a6dbf36ff16..00000000000 --- a/packages/cucumber/.npmignore +++ /dev/null @@ -1,16 +0,0 @@ -# Node -node_modules -*.log -.npmignore -npm-shrinkwrap.json - -# Build artifacts -.nyc_output -staging -target - -# Specs -spec -mocha.opts -tsconfig*.json -tslint.json diff --git a/packages/cucumber/LICENSE.md b/packages/cucumber/LICENSE.md deleted file mode 100644 index 9c8f3ea0871..00000000000 --- a/packages/cucumber/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - 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. \ No newline at end of file diff --git a/packages/cucumber/NOTICE.md b/packages/cucumber/NOTICE.md deleted file mode 100644 index 24c0543b6ba..00000000000 --- a/packages/cucumber/NOTICE.md +++ /dev/null @@ -1 +0,0 @@ -Copyright 2016- Jan Molak, smartcode ltd. diff --git a/packages/cucumber/README.md b/packages/cucumber/README.md deleted file mode 100644 index 6626fccba68..00000000000 --- a/packages/cucumber/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Serenity/JS - -Serenity/JS is a node.js library designed to make acceptance and regression testing of modern web applications -faster, more collaborative and easier to scale. - -Find out more at [serenity-js.org](http://serenity-js.org)! diff --git a/packages/cucumber/package.json b/packages/cucumber/package.json deleted file mode 100644 index 83a4c2910b3..00000000000 --- a/packages/cucumber/package.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "name": "@serenity-js/cucumber", - "version": "1.0.0", - "description": "Enables Serenity/JS to run Cucumber JS 1.3.x test scenarios", - "author": "Jan Molak ", - "homepage": "http://serenity-js.org", - "license": "Apache-2.0", - "config": { - "access": "public" - }, - "main": "lib/register.js", - "typings": "lib/index.d.ts", - "keywords": [ - "serenity-js", - "cucumber", - "tdd", - "bdd", - "test", - "testing" - ], - "scripts": { - "clean": "rimraf lib", - "lint": "tslint --project tsconfig.json --config ../../tslint.json --format stylish", - "test": "nyc --report-dir ../../target/coverage/cucumber mocha --opts ../../mocha.opts 'spec/**/*.spec.*'", - "package": "tsc --project tsconfig.json", - "verify": "npm run clean && npm run lint && npm test && npm run package" - }, - "repository": { - "type": "git", - "url": "https://github.com/jan-molak/serenity-js.git" - }, - "bugs": { - "url": "https://github.com/jan-molak/serenity-js/issues" - }, - "engines": { - "node": ">= 6.9.x", - "npm": ">= 3" - }, - "peerDependencies": { - "cucumber": ">= 1.3.3" - }, - "devDependencies": { - "@serenity-js/integration-testing": "*", - "@types/cucumber": "1.3.3", - "cucumber": "1.3.3" - }, - "dependencies": { - "@serenity-js/core": "^1.4.0" - }, - "nyc": { - "include": [ - "src/*.ts", - "src/**/*.ts" - ], - "exclude": [ - "features", - "lib", - "node_modules", - "spec", - "staging" - ], - "extension": [ - ".ts" - ], - "require": [ - "ts-node/register" - ], - "reporter": [ - "json", - "text-summary", - "html" - ], - "cache": true, - "all": true - } -} diff --git a/packages/cucumber/register.js b/packages/cucumber/register.js deleted file mode 100644 index 84086881da3..00000000000 --- a/packages/cucumber/register.js +++ /dev/null @@ -1,3 +0,0 @@ -'use strict'; - -module.exports = require('./lib/register'); diff --git a/packages/cucumber/spec/cucumber/configure.ts b/packages/cucumber/spec/cucumber/configure.ts deleted file mode 100644 index 577806cd15c..00000000000 --- a/packages/cucumber/spec/cucumber/configure.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { serenity } from '@serenity-js/core'; -import { childProcessReporter } from '@serenity-js/integration-testing'; - -export = function() { - - serenity.configure({ - crew: [ - childProcessReporter(), - ], - }); -} \ No newline at end of file diff --git a/packages/cucumber/spec/cucumber/last_of.ts b/packages/cucumber/spec/cucumber/last_of.ts deleted file mode 100644 index aea32118543..00000000000 --- a/packages/cucumber/spec/cucumber/last_of.ts +++ /dev/null @@ -1,4 +0,0 @@ -// import { lastOf } from '@serenity-js/integration-testing'; // todo: upgrade TS to support this -import { DomainEvent } from '@serenity-js/core/lib/domain'; - -export const lastOf = (type: typeof DomainEvent, events: Array>) => events.filter(e => e instanceof type).pop(); diff --git a/packages/cucumber/spec/cucumber/spawner.ts b/packages/cucumber/spec/cucumber/spawner.ts deleted file mode 100644 index e85b0644e48..00000000000 --- a/packages/cucumber/spec/cucumber/spawner.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { spawner } from '@serenity-js/integration-testing'; -import { Spawned } from '@serenity-js/integration-testing'; - -const node_modules = `${__dirname}/../../node_modules`; - -const cucumberSpawner = spawner( - `${node_modules}/.bin/cucumber-js`, - { cwd: `${__dirname}/../`, silent: true }, -); - -export const cucumber = (...params: string[]): Spawned => cucumberSpawner( - '--compiler', 'ts:ts-node/register', - '--require', './../src/register.ts', - '--require', './cucumber/configure.ts', - '--require', 'features/step_definitions/steps.ts', - ...params, -); diff --git a/packages/cucumber/spec/expect.ts b/packages/cucumber/spec/expect.ts deleted file mode 100644 index b32b1d1caec..00000000000 --- a/packages/cucumber/spec/expect.ts +++ /dev/null @@ -1,8 +0,0 @@ -import chai = require('chai'); -import sinonChai = require('sinon-chai'); -import chaiAsPromised = require('chai-as-promised'); - -chai.use(sinonChai); -chai.use(chaiAsPromised); - -export const expect = chai.expect; diff --git a/packages/cucumber/spec/features/recognises_a_failing_scenario.feature b/packages/cucumber/spec/features/recognises_a_failing_scenario.feature deleted file mode 100644 index 2e6e0601ff8..00000000000 --- a/packages/cucumber/spec/features/recognises_a_failing_scenario.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises a failing scenario - - Scenario: A failing scenario with a synchronous interface - Given a step that fails with a synchronous interface - - Scenario: A failing scenario with a callback interface - Given a step that fails with a callback interface - - Scenario: A failing scenario with a promise interface - Given a step that fails with a promise interface diff --git a/packages/cucumber/spec/features/recognises_a_passing_scenario.feature b/packages/cucumber/spec/features/recognises_a_passing_scenario.feature deleted file mode 100644 index d9a734deced..00000000000 --- a/packages/cucumber/spec/features/recognises_a_passing_scenario.feature +++ /dev/null @@ -1,11 +0,0 @@ -Feature: Recognises a passing scenario - - Scenario: A passing scenario with a synchronous interface - Given a step that passes with a synchronous interface - - Scenario: A passing scenario with a callback interface - Given a step that passes with a callback interface - - Scenario: A passing scenario with a promise interface - Given a step that passes with a promise interface - diff --git a/packages/cucumber/spec/features/recognises_a_skipped_scenario.feature b/packages/cucumber/spec/features/recognises_a_skipped_scenario.feature deleted file mode 100644 index 1e2f9a697c8..00000000000 --- a/packages/cucumber/spec/features/recognises_a_skipped_scenario.feature +++ /dev/null @@ -1,5 +0,0 @@ -Feature: Recognises a skipped scenario - - @wip - Scenario: A skipped scenario - Given a scenario that is never executed \ No newline at end of file diff --git a/packages/cucumber/spec/features/recognises_activities_of_actors_throughout_the_scenario.feature b/packages/cucumber/spec/features/recognises_activities_of_actors_throughout_the_scenario.feature deleted file mode 100644 index e60f6d9c6d4..00000000000 --- a/packages/cucumber/spec/features/recognises_activities_of_actors_throughout_the_scenario.feature +++ /dev/null @@ -1,11 +0,0 @@ -Feature: Recognises setup and teardown activities supporting a scenario - - Background: - Given Adam has added the following customer records to the database: - | name | email_address | - | Bob | bob@megacorp.com | - - Scenario: Alice finds customer's email by their name - When Alice looks for a customer called Bob - Then she should see that the customer's email address is bob@megacorp.com - diff --git a/packages/cucumber/spec/features/recognises_ambiguous_steps.feature b/packages/cucumber/spec/features/recognises_ambiguous_steps.feature deleted file mode 100644 index e77b8e93a7b..00000000000 --- a/packages/cucumber/spec/features/recognises_ambiguous_steps.feature +++ /dev/null @@ -1,5 +0,0 @@ -Feature: Recognises a scenario with ambiguous step definitions - - Scenario: Ambigail logs in using an email address - Given Ambigail logs in as ambigail@example.com - diff --git a/packages/cucumber/spec/features/recognises_an_explicitly_pending_scenario.feature b/packages/cucumber/spec/features/recognises_an_explicitly_pending_scenario.feature deleted file mode 100644 index 207efbe794a..00000000000 --- a/packages/cucumber/spec/features/recognises_an_explicitly_pending_scenario.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises explicitly pending scenarios - - Scenario: An explicitly pending synchronous scenario - Given a pending step with a synchronous interface - - Scenario: An explicitly pending callback scenario - Given a pending step with a callback interface - - Scenario: An explicitly pending promise scenario - Given a pending step with a promise interface diff --git a/packages/cucumber/spec/features/recognises_an_implicitly_pending_scenario.feature b/packages/cucumber/spec/features/recognises_an_implicitly_pending_scenario.feature deleted file mode 100644 index 846660836b6..00000000000 --- a/packages/cucumber/spec/features/recognises_an_implicitly_pending_scenario.feature +++ /dev/null @@ -1,4 +0,0 @@ -Feature: Recognises an implicitly pending scenario - - Scenario: An implicitly pending scenario - Given a scenario with no defined steps diff --git a/packages/cucumber/spec/features/recognises_multi_value_tags.feature b/packages/cucumber/spec/features/recognises_multi_value_tags.feature deleted file mode 100644 index a52fb32b10b..00000000000 --- a/packages/cucumber/spec/features/recognises_multi_value_tags.feature +++ /dev/null @@ -1,6 +0,0 @@ -@cucumber -Feature: Recognises scenario tags - - @regression @issues:MY-PROJECT-123,MY-PROJECT-789 - Scenario: A regression test covering two issues - Given a step that passes \ No newline at end of file diff --git a/packages/cucumber/spec/features/recognises_single_value_tags.feature b/packages/cucumber/spec/features/recognises_single_value_tags.feature deleted file mode 100644 index 0ded436bd2b..00000000000 --- a/packages/cucumber/spec/features/recognises_single_value_tags.feature +++ /dev/null @@ -1,6 +0,0 @@ -@cucumber -Feature: Recognises scenario tags - - @regression @issue:MY-PROJECT-123 - Scenario: A regression test covering one issue - Given a step that passes diff --git a/packages/cucumber/spec/features/recognises_special_step_arguments.feature b/packages/cucumber/spec/features/recognises_special_step_arguments.feature deleted file mode 100644 index 4618a1c54b5..00000000000 --- a/packages/cucumber/spec/features/recognises_special_step_arguments.feature +++ /dev/null @@ -1,19 +0,0 @@ -Feature: Recognises special step arguments - - # https://github.com/cucumber/cucumber-js/blob/b659dc887ee8e94149b2148e83857b6c653aa2fa/features/data_tables.feature - @datatable - Scenario: Reports a data table argument - - Given the following accounts: - | name | email | twitter | - | Jan | jan.molak@serenity.io | @JanMolak | - | John | john.smart@serenity.io | @wakaleo | - - @docstring - Scenario: Reports a DocString argument - - Given an example.ts file with the following contents: - """ - export const noop = (_) => _; - export const sum = (a, b) => a + b; - """ \ No newline at end of file diff --git a/packages/cucumber/spec/features/recognises_tests_that_timed_out.feature b/packages/cucumber/spec/features/recognises_tests_that_timed_out.feature deleted file mode 100644 index 0ef1d8206f0..00000000000 --- a/packages/cucumber/spec/features/recognises_tests_that_timed_out.feature +++ /dev/null @@ -1,9 +0,0 @@ -Feature: Recognises a failing scenario - - Scenario Outline: A scenario with a step that times out - Given a slow, step - - Examples: - | TYPE | - | callback | - | promise | diff --git a/packages/cucumber/spec/features/step_definitions/ambiguous.steps.ts b/packages/cucumber/spec/features/step_definitions/ambiguous.steps.ts deleted file mode 100644 index a88f821e516..00000000000 --- a/packages/cucumber/spec/features/step_definitions/ambiguous.steps.ts +++ /dev/null @@ -1,6 +0,0 @@ -export = function() { - - this.Given(/^Ambigail logs in as (.*@.*)$/, email => {}); // tslint:disable-line:no-empty - - this.Given(/^Ambigail logs in as (.*)/, username => {}); // tslint:disable-line:no-empty -}; diff --git a/packages/cucumber/spec/features/step_definitions/steps.ts b/packages/cucumber/spec/features/step_definitions/steps.ts deleted file mode 100644 index 1dc99119e24..00000000000 --- a/packages/cucumber/spec/features/step_definitions/steps.ts +++ /dev/null @@ -1,113 +0,0 @@ -enum StepInterface { - SYNCHRONOUS, - CALLBACK, - PROMISE, -} - -enum StepResult { - SUCCESS, - FAILURE, - PENDING, -} - -function createFailingStep(stepInterface: StepInterface) { - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - process.nextTick(cb.bind(null, new Error('Assertion failed'))); - }; - case StepInterface.PROMISE: - return () => { - return new Promise((resolve, reject) => { - process.nextTick(() => { - reject(new Error('Assertion failed')); - }); - }); - }; - case StepInterface.SYNCHRONOUS: - default: - return () => { - throw new Error('Assertion failed'); - }; - } -} - -function createPassingStep(stepInterface: StepInterface, result: StepResult) { - const resultValue = StepResult[result].toLowerCase(); - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - process.nextTick(cb.bind(null, null, resultValue)); - }; - case StepInterface.PROMISE: - return () => { - return new Promise(resolve => process.nextTick(() => resolve(resultValue))); - }; - case StepInterface.SYNCHRONOUS: - default: - return () => { - return resultValue; - }; - } -} - -function createSlowStep(stepInterface: StepInterface, timeout: number) { - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - setTimeout(cb, timeout); - }; - case StepInterface.PROMISE: - default: - return () => { - return new Promise(resolve => setTimeout(resolve, timeout)); - }; - } -} - -function createStep(stepInterface: StepInterface, result: StepResult) { - if (result === StepResult.FAILURE) { - return createFailingStep(stepInterface); - } - return createPassingStep(stepInterface, result); -} - -export = function() { - - this.Given(/^a step that passes$/, - createStep(StepInterface.PROMISE, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.SUCCESS)); - - this.Given(/^a step that fails with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.FAILURE)); - - this.Given(/^a step that fails with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.FAILURE)); - - this.Given(/^a step that fails with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.FAILURE)); - - this.Given(/^a pending step with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.PENDING)); - - this.Given(/^a pending step with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.PENDING)); - - this.Given(/^a pending step with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.PENDING)); - - this.Given(/^the following.*$/, data => Promise.resolve()); - - this.Given(/^an example.ts file with the following contents:$/, docstring => Promise.resolve()); - - this.Given(/^a slow, callback step$/, { timeout: 100 }, createSlowStep(StepInterface.CALLBACK, 2000)); - this.Given(/^a slow, promise step$/, { timeout: 100 }, createSlowStep(StepInterface.PROMISE, 2000)); -}; diff --git a/packages/cucumber/spec/features/step_definitions/steps_with_activities.ts b/packages/cucumber/spec/features/step_definitions/steps_with_activities.ts deleted file mode 100644 index 3b5b4f00bb4..00000000000 --- a/packages/cucumber/spec/features/step_definitions/steps_with_activities.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { stage } from '../support/stage'; -import { - AddACustomerRecord, - CheckIfFoundCustomerEmailAddressIs, - LooksForCustomerByName, - StartTheCustomerDatabaseUp, - StopTheCustomerDatabase, -} from '../support/tasks'; - -import { TableDefinition } from 'cucumber'; - -export = function() { - - this.Before((...args: any[]) => stage.theActorCalled('Adam').attemptsTo( - StartTheCustomerDatabaseUp(), - )); - - this.Given(/^(.*?) has added the following customer records to the database:$/, - (actor_name: string, records: TableDefinition) => stage.theActorCalled(actor_name).attemptsTo( - ...records.hashes().map(record => AddACustomerRecord(record.name, record.email_address)), - )); - - this.When(/^(.*?) looks for a customer called (.*?)$/, (actor_name: string, customer_name: string) => - stage.theActorCalled(actor_name).attemptsTo( - LooksForCustomerByName(customer_name), - )); - - this.Then(/^she should see that the customer's email address is (.*?)$/, (expected_email_address: string) => - stage.theActorInTheSpotlight().attemptsTo( - CheckIfFoundCustomerEmailAddressIs(expected_email_address), - )); - - this.After((...args: any[]) => stage.theActorCalled('Adam').attemptsTo( - StopTheCustomerDatabase(), - )); -}; diff --git a/packages/cucumber/spec/features/support/stage.ts b/packages/cucumber/spec/features/support/stage.ts deleted file mode 100644 index 6c41e30ca95..00000000000 --- a/packages/cucumber/spec/features/support/stage.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { serenity } from '@serenity-js/core'; -import { Actor } from '@serenity-js/core/lib/screenplay'; -import { Cast, Stage } from '@serenity-js/core/lib/stage'; - -class Actors implements Cast { - private readonly actors: { [name: string]: Actor } = {}; - - actor(name: string) { - if (! this.actors[name]) { - this.actors[name] = Actor.named(name); - } - - return this.actors[name]; - } -} - -export const stage: Stage = serenity.callToStageFor(new Actors()); diff --git a/packages/cucumber/spec/features/support/tasks.ts b/packages/cucumber/spec/features/support/tasks.ts deleted file mode 100644 index ab79d596fdd..00000000000 --- a/packages/cucumber/spec/features/support/tasks.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { Task } from '@serenity-js/core/lib/screenplay'; - -export const StartTheCustomerDatabaseUp = () => Task.where(`#actor starts up the customer database`); -export const StopTheCustomerDatabase = () => Task.where(`#actor stops the customer database`); - -export const AddACustomerRecord = (name: string, emailAddress: string) => - Task.where(`#actor adds a customer record for ${ name }`); - -export const LooksForCustomerByName = (name: string) => - Task.where(`#actor looks for a customer called ${ name }`); - -export const CheckIfFoundCustomerEmailAddressIs = (email_address: string) => - Task.where(`#actor checks if the found customer's email address is ${ email_address }`); diff --git a/packages/cucumber/spec/recognises_activities_of_actors_throughout_the_scenario.spec.ts b/packages/cucumber/spec/recognises_activities_of_actors_throughout_the_scenario.spec.ts deleted file mode 100644 index 616875eed58..00000000000 --- a/packages/cucumber/spec/recognises_activities_of_actors_throughout_the_scenario.spec.ts +++ /dev/null @@ -1,61 +0,0 @@ -import { ActivityFinished, ActivityStarts, RecordedScene, SceneFinished, SceneStarts, Tag } from '@serenity-js/core/lib/domain'; - -import { cucumber } from './cucumber/spawner'; - -import { expect } from './expect'; - -describe('When working with Cucumber', function() { - - this.timeout(5 * 1000); - - describe('Serenity/JS', () => { - - const Expected_Events = [ - { type: SceneStarts, name: `Alice finds customer's email by their name` }, - { type: ActivityStarts, name: `Adam starts up the customer database` }, - { type: ActivityFinished, name: `Adam starts up the customer database` }, - { type: ActivityStarts, name: `Given Adam has added the following customer records to the database:` }, - { type: ActivityStarts, name: `Adam adds a customer record for Bob` }, - { type: ActivityFinished, name: `Adam adds a customer record for Bob` }, - { type: ActivityFinished, name: `Given Adam has added the following customer records to the database:` }, - { type: ActivityStarts, name: `When Alice looks for a customer called Bob` }, - { type: ActivityStarts, name: `Alice looks for a customer called Bob` }, - { type: ActivityFinished, name: `Alice looks for a customer called Bob` }, - { type: ActivityFinished, name: `When Alice looks for a customer called Bob` }, - { type: ActivityStarts, name: `Then she should see that the customer's email address is bob@megacorp.com` }, - { type: ActivityStarts, name: `Alice checks if the found customer's email address is bob@megacorp.com` }, - { type: ActivityFinished, name: `Alice checks if the found customer's email address is bob@megacorp.com` }, - { type: ActivityFinished, name: `Then she should see that the customer's email address is bob@megacorp.com` }, - { type: ActivityStarts, name: `Adam stops the customer database` }, - { type: ActivityFinished, name: `Adam stops the customer database` }, - { type: SceneFinished, name: `Alice finds customer's email by their name` }, - ]; - - it('recognises activities that happen before and after the scenario', () => { - - const spawned = cucumber( - '--require', 'features/step_definitions/steps_with_activities.ts', - 'features/recognises_activities_of_actors_throughout_the_scenario.feature', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(Expected_Events.length); - - Expected_Events.forEach((e, i: number) => { - switch (e.type) { - case SceneStarts: - case ActivityStarts: - expect(spawned.messages[i].value.name).to.include(e.name); - break; - case ActivityFinished: - case SceneFinished: - expect(spawned.messages[i].value.subject.name).to.include(e.name); - break; - default: - throw new Error('Unexpected event'); - } - }); - }); - }); - }); -}); diff --git a/packages/cucumber/spec/recognises_scenario_results.spec.ts b/packages/cucumber/spec/recognises_scenario_results.spec.ts deleted file mode 100644 index 4202f4bf0b8..00000000000 --- a/packages/cucumber/spec/recognises_scenario_results.spec.ts +++ /dev/null @@ -1,110 +0,0 @@ -import { ActivityFinished, Result, SceneFinished } from '@serenity-js/core/lib/domain'; - -import * as _ from 'lodash'; -import { cucumber } from './cucumber/spawner'; -import { expect } from './expect'; - -describe('When working with Cucumber', function() { - - this.timeout(10 * 1000); - - describe('Serenity/JS', () => { - - const stepApiTypes = 3; - const messagesPerStep = 4; - const messagesPerFeature = stepApiTypes * messagesPerStep; - - it ('reports passing scenarios', () => { - const spawned = cucumber('features/recognises_a_passing_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.SUCCESS]); - }); - }); - }); - - it ('ignores skipped scenarios', () => { - const spawned = cucumber('--tags', '~@wip', 'features/recognises_a_skipped_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(0); - }); - }); - - it ('reports implicitly pending scenarios', () => { - const spawned = cucumber('features/recognises_an_implicitly_pending_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerStep); - - const lastMessage = spawned.messages.pop(); - - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it ('reports explicitly pending scenarios', () => { - const spawned = cucumber('features/recognises_an_explicitly_pending_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - }); - - it('reports failing scenarios', () => { - const spawned = cucumber('features/recognises_a_failing_scenario.feature'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.FAILURE]); - }); - }); - }); - - it('reports ambiguous steps as errors and suggests how to fix them', () => { - const spawned = cucumber( - '--require', 'features/step_definitions/ambiguous.steps.ts', - 'features/recognises_ambiguous_steps.feature', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(4); - - const activityFinished = spawned.messages[2]; - - expect(activityFinished).to.be.instanceOf(ActivityFinished); - expect(Result[activityFinished.value.result]).to.equal(Result[Result.ERROR]); - expect(activityFinished.value.error.message).to.equal( - 'There should be only one step definition matching a given step, yet there seem to be several:\n' + - '/^Ambigail logs in as (.*@.*)$/ - features/step_definitions/ambiguous.steps.ts:3\n' + - '/^Ambigail logs in as (.*)/ - features/step_definitions/ambiguous.steps.ts:5', - ); - - const sceneFinished = spawned.messages[3]; - - expect(sceneFinished).to.be.instanceOf(SceneFinished); - expect(Result[sceneFinished.value.result]).to.equal(Result[Result.ERROR]); - }); - }); - }); -}); diff --git a/packages/cucumber/spec/recognises_scenario_tags.spec.ts b/packages/cucumber/spec/recognises_scenario_tags.spec.ts deleted file mode 100644 index 35793fa4bdb..00000000000 --- a/packages/cucumber/spec/recognises_scenario_tags.spec.ts +++ /dev/null @@ -1,67 +0,0 @@ -import { RecordedScene, SceneFinished, SceneStarts, Tag } from '@serenity-js/core/lib/domain'; - -import { lastOf } from './cucumber/last_of'; -import { cucumber } from './cucumber/spawner'; - -import { expect } from './expect'; - -describe('When working with Cucumber', function() { - - this.timeout(5 * 1000); - - describe('Serenity/JS', () => { - - it('recognises single-value scenario tags', () => { - - const spawned = cucumber('features/recognises_single_value_tags.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - const sceneStarts = lastOf(SceneStarts, spawned.messages); - - expect(sceneStarts.value).to.be.instanceOf(RecordedScene); - expect(sceneStarts.value.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issue', [ 'MY-PROJECT-123' ]), - ]); - - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneFinished).to.be.instanceOf(SceneFinished); - expect(sceneFinished.value.subject).to.be.instanceOf(RecordedScene); - expect(sceneFinished.value.subject.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issue', [ 'MY-PROJECT-123' ]), - ]); - }); - }); - - it('recognises multi-value scenario tags', () => { - - const spawned = cucumber('features/recognises_multi_value_tags.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - const sceneStarts = lastOf(SceneStarts, spawned.messages); - - expect(sceneStarts).to.be.instanceOf(SceneStarts); - expect(sceneStarts.value).to.be.instanceOf(RecordedScene); - expect(sceneStarts.value.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issues', [ 'MY-PROJECT-123', 'MY-PROJECT-789' ]), - ]); - - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneFinished).to.be.instanceOf(SceneFinished); - expect(sceneFinished.value.subject).to.be.instanceOf(RecordedScene); - expect(sceneFinished.value.subject.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issues', [ 'MY-PROJECT-123', 'MY-PROJECT-789' ]), - ]); - }); - }); - }); -}); diff --git a/packages/cucumber/spec/recognises_special_step_arguments.spec.ts b/packages/cucumber/spec/recognises_special_step_arguments.spec.ts deleted file mode 100644 index 7a1efb3d314..00000000000 --- a/packages/cucumber/spec/recognises_special_step_arguments.spec.ts +++ /dev/null @@ -1,58 +0,0 @@ -import { ActivityFinished, ActivityStarts } from '@serenity-js/core/lib/domain'; - -import { lastOf } from './cucumber/last_of'; -import { cucumber } from './cucumber/spawner'; -import { expect } from './expect'; - -describe('When working with Cucumber', function() { - - this.timeout(5 * 1000); - - describe('Serenity/JS', () => { - - const messagesPerStep = 4; - - it ('reports data table arguments', () => { - const spawned = cucumber('--tags', '@datatable', 'features/recognises_special_step_arguments.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerStep); - - const - cucumberStepDescriptionFromActivityStartedMessage = lastOf(ActivityStarts, spawned.messages).value.name, - cucumberStepDescriptionFromActivityFinishedMessage = lastOf(ActivityFinished, spawned.messages).value.subject.name; - - expect(cucumberStepDescriptionFromActivityStartedMessage).to.equal([ - 'Given the following accounts:', - '| name | email | twitter |', - '| Jan | jan.molak@serenity.io | @JanMolak |', - '| John | john.smart@serenity.io | @wakaleo |', - ].join('\n')); - - expect(cucumberStepDescriptionFromActivityStartedMessage). - to.equal(cucumberStepDescriptionFromActivityFinishedMessage); - }); - }); - - it ('reports DocString arguments', () => { - const spawned = cucumber('--tags', '@docstring', 'features/recognises_special_step_arguments.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerStep); - - const - cucumberStepDescriptionFromActivityStartedMessage = lastOf(ActivityStarts, spawned.messages).value.name, - cucumberStepDescriptionFromActivityFinishedMessage = lastOf(ActivityFinished, spawned.messages).value.subject.name; - - expect(cucumberStepDescriptionFromActivityStartedMessage).to.equal([ - 'Given an example.ts file with the following contents:', - 'export const noop = (_) => _;', - 'export const sum = (a, b) => a + b;', - ].join('\n')); - - expect(cucumberStepDescriptionFromActivityStartedMessage). - to.equal(cucumberStepDescriptionFromActivityFinishedMessage); - }); - }); - }); -}); diff --git a/packages/cucumber/spec/recognises_timed_out_scenarios.spec.ts b/packages/cucumber/spec/recognises_timed_out_scenarios.spec.ts deleted file mode 100644 index d64ec009a85..00000000000 --- a/packages/cucumber/spec/recognises_timed_out_scenarios.spec.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { Result, SceneFinished } from '@serenity-js/core/lib/domain'; -import { cucumber } from './cucumber/spawner'; - -import { expect } from './expect'; - -import * as _ from 'lodash'; - -describe('When working with Cucumber', function() { - - this.timeout(5 * 1000); - - describe('Serenity/JS', () => { - - const stepApiTypes = 2; - const messagesPerStep = 4; - const messagesPerFeature = stepApiTypes * messagesPerStep; - - it ('reports timed-out scenarios', () => { - const spawned = cucumber('features/recognises_tests_that_timed_out.feature'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.ERROR]); - expect(lastMessage.value.error.message).to.match(/function timed out/); - }); - }); - }); - }); -}); diff --git a/packages/cucumber/src/listener.ts b/packages/cucumber/src/listener.ts deleted file mode 100644 index 696d28e306a..00000000000 --- a/packages/cucumber/src/listener.ts +++ /dev/null @@ -1,60 +0,0 @@ -import { serenity } from '@serenity-js/core'; - -import { ActivityFinished, ActivityStarts, SceneFinished, SceneStarts } from '@serenity-js/core/lib/domain'; -import * as Cucumber from 'cucumber'; - -import { activityFrom, errorIfPresentIn, outcome, sceneFrom } from './transformations'; - -const cucumber = require('cucumber'); // tslint:disable-line:no-var-requires - -type Callback = (error?: Error) => void; - -const listener = cucumber.Listener({ timeout: serenity.config.stageCueTimeout }); - -listener.handleBeforeScenarioEvent = function(scenario: Cucumber.events.ScenarioPayload, callback: Callback) { - serenity.notify(new SceneStarts(sceneFrom(scenario))); - - callback(); -}; - -listener.handleBeforeStepEvent = function(step: Cucumber.events.StepPayload, callback: () => void) { - if (! step.isHidden()) { - serenity.notify(new ActivityStarts(activityFrom(step))); - } - - callback(); -}; - -listener.handleStepResultEvent = function(result: Cucumber.events.StepResultPayload, callback: () => void) { - const step = result.getStep(); - - // "before" and "after" steps emit an event even if the keywords themselves are not present in the scenario... - if (!step.isHidden()) { - serenity.notify(new ActivityFinished(outcome(activityFrom(step), result.getStatus(), errorIfPresentIn(result)))); - } - - callback(); -}; - -listener.handleScenarioResultEvent = function(result: Cucumber.events.ScenarioResultPayload, callback: () => void) { - const scenario = result.getScenario(); - - serenity.notify(new SceneFinished(outcome(sceneFrom(scenario), result.getStatus(), errorIfPresentIn(result)))); - - callback(); -}; - -listener.handleAfterScenarioEvent = function(scenario: Cucumber.events.ScenarioPayload, callback: Callback) { - serenity.stageManager().waitForNextCue().then(() => callback(), error => callback(error)); -}; - -// cucumber.Listener API: -// handleAfterStepEvent (step: events.StepPayload, callback: () => void) => callback(); -// handleBeforeFeaturesEvent (features: events.FeaturesPayload, callback: () => void) => callback(); -// handleBeforeFeatureEvent (feature: events.FeaturePayload, callback: () => void) => callback(); -// handleAfterScenarioEvent (scenario: events.ScenarioPayload, callback: () => void) => callback(); -// handleAfterFeatureEvent (feature: events.FeaturePayload, callback: () => void) => callback(); -// handleFeaturesResultEvent (featuresResult: events.FeaturesResultPayload, callback: () => void) => callback(); -// handleAfterFeaturesEvent (features: events.FeaturesPayload, callback: () => void) => callback(); - -export { listener }; diff --git a/packages/cucumber/src/register.ts b/packages/cucumber/src/register.ts deleted file mode 100644 index 8019316fb0c..00000000000 --- a/packages/cucumber/src/register.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { listener } from './listener'; - -export = function() { - - this.registerListener(listener); -}; diff --git a/packages/cucumber/src/transformations.ts b/packages/cucumber/src/transformations.ts deleted file mode 100644 index a09e830934b..00000000000 --- a/packages/cucumber/src/transformations.ts +++ /dev/null @@ -1,113 +0,0 @@ -import { Outcome, RecordedActivity, RecordedScene, Result, Tag } from '@serenity-js/core/lib/domain'; -import path = require('path'); - -import * as Cucumber from 'cucumber'; - -export function sceneFrom(scenario: Cucumber.events.ScenarioPayload): RecordedScene { - return new CucumberScene(scenario); -} - -export function activityFrom(step: Cucumber.events.StepPayload): RecordedActivity { - // todo: override RecordedTask::location - return new RecordedActivity(fullNameOf(step)); -} - -export function outcome(subject: T, stepStatus: string, error: Error | undefined): Outcome { - return new Outcome(subject, serenityResultFrom(stepStatus, error), error); -} - -function catchProblemsWithAmbiguousStepDefinitions(result: Cucumber.events.StepResultPayload): Error | undefined { - const ambiguousStepDefinitions = (result.getAmbiguousStepDefinitions() || []).map(stepDefinition => { - const pattern = stepDefinition.getPattern().toString(); - const relativeUri = path.relative(process.cwd(), stepDefinition.getUri()); - const line = stepDefinition.getLine(); - return `${pattern} - ${relativeUri}:${line}`; - }); - - if (!! ambiguousStepDefinitions.length) { - return new Error(ambiguousStepDefinitions.reduce( - (message, issueLocation) => `${message}\n${issueLocation}`, - 'There should be only one step definition matching a given step, yet there seem to be several:', - )); - } - - return undefined; -} - -export function errorIfPresentIn(result: Cucumber.events.StepResultPayload | Cucumber.events.ScenarioResultPayload): Error | undefined { - - const error: Error | string | undefined = result.getFailureException() as any; - - switch (typeof error) { // tslint:disable-line:switch-default - case 'string': return new Error(error as string); - case 'object': return error as Error; - case 'function': return error as Error; - } - - return (!! result['getAmbiguousStepDefinitions']) // tslint:disable-line:no-string-literal - ? catchProblemsWithAmbiguousStepDefinitions(result as Cucumber.events.StepResultPayload) - : undefined; -} - -// --- - -function fullNameOf(step: Cucumber.events.StepPayload): string { - - const serialise = (argument: any) => { - // tslint:disable-next-line:switch-default - the only possible values are DataTable and DocString - switch (argument.getType()) { - case 'DataTable': - return '\n' + argument.raw().map(row => `| ${row.join(' | ')} |`).join('\n'); - case 'DocString': - return `\n${ argument.getContent() }`; - } - }; - - return [ - step.getKeyword(), - step.getName(), - (step as any).getArguments().map(serialise).join('\n'), // todo: submit getArguments() to DefinitelyTyped - ].join('').trim(); -} - -function serenityResultFrom(stepStatus: string, error?: Error): Result { - const timeOut = (e: Error) => e && /timed out/.test(e.message); - - const results = { - undefined: Result.PENDING, - ambiguous: Result.ERROR, - failed: Result.FAILURE, - pending: Result.PENDING, - passed: Result.SUCCESS, - skipped: Result.SKIPPED, - }; - - if (! results[stepStatus]) { - throw new Error(`Couldn't map '${ stepStatus }' to a Serenity Result`); - } - - return timeOut(error) - ? Result.ERROR - : results[stepStatus]; -} - -function toSerenityTag(cucumberTag: Cucumber.Tag): Tag { - return Tag.from(cucumberTag.getName()); -} - -class CucumberScene extends RecordedScene { - constructor(scenario: Cucumber.events.ScenarioPayload) { - super( - scenario.getName(), - scenario.getFeature().getName(), - { - path: scenario.getUri(), - line: scenario.getLine(), - }, - scenario.getTags().map(toSerenityTag), - `${scenario.getFeature().getName()}:${scenario.getLine()}:${scenario.getName()}`, - ); - } - - // todo: override CucumberScene::location to return the line and column retrieved from cucumber event -} diff --git a/packages/cucumber/tsconfig.json b/packages/cucumber/tsconfig.json deleted file mode 100644 index 422e9cd214c..00000000000 --- a/packages/cucumber/tsconfig.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true, - "outDir": "./lib" - }, - - "include": [ - "src/**/*.ts" - ], - "exclude": [ - "features", - "spec", - "node_modules" - ] -} \ No newline at end of file diff --git a/packages/integration-testing/.gitignore b/packages/integration-testing/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/packages/integration-testing/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/packages/integration-testing/.npmignore b/packages/integration-testing/.npmignore deleted file mode 100644 index 5ba40baf96e..00000000000 --- a/packages/integration-testing/.npmignore +++ /dev/null @@ -1,17 +0,0 @@ -# Node -node_modules -*.log -.npmignore -npm-shrinkwrap.json - -# Build artifacts -.nyc_output -staging -target - -# Specs -spec -features -mocha.opts -tsconfig*.json -tslint.json diff --git a/packages/integration-testing/LICENSE.md b/packages/integration-testing/LICENSE.md deleted file mode 100644 index 9c8f3ea0871..00000000000 --- a/packages/integration-testing/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - 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. \ No newline at end of file diff --git a/packages/integration-testing/NOTICE.md b/packages/integration-testing/NOTICE.md deleted file mode 100644 index 24c0543b6ba..00000000000 --- a/packages/integration-testing/NOTICE.md +++ /dev/null @@ -1 +0,0 @@ -Copyright 2016- Jan Molak, smartcode ltd. diff --git a/packages/integration-testing/README.md b/packages/integration-testing/README.md deleted file mode 100644 index 6626fccba68..00000000000 --- a/packages/integration-testing/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Serenity/JS - -Serenity/JS is a node.js library designed to make acceptance and regression testing of modern web applications -faster, more collaborative and easier to scale. - -Find out more at [serenity-js.org](http://serenity-js.org)! diff --git a/packages/integration-testing/package.json b/packages/integration-testing/package.json deleted file mode 100644 index b851cd14c19..00000000000 --- a/packages/integration-testing/package.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "name": "@serenity-js/integration-testing", - "version": "54.0.0", - "description": "Internal module to help test integration of Serenity/JS with test runners and frameworks", - "author": "Jan Molak ", - "homepage": "http://serenity-js.org", - "license": "Apache-2.0", - "private": true, - "config": { - "access": "private" - }, - "main": "lib/index.js", - "typings": "lib/index.d.ts", - "keywords": [ - "serenity-js", - "internal" - ], - "scripts": { - "clean": "rimraf lib", - "lint": "tslint --project tsconfig.json --config ../../tslint.json --format stylish", - "test": "mocha --opts ../../mocha.opts 'spec/**/*.spec.*'", - "package": "tsc --project tsconfig.json", - "verify": "npm run clean && npm run lint && npm test && npm run package" - }, - "repository": { - "type": "git", - "url": "https://github.com/jan-molak/serenity-js.git" - }, - "bugs": { - "url": "https://github.com/jan-molak/serenity-js/issues" - }, - "engines": { - "node": ">= 6.9.x", - "npm": ">= 3" - }, - "devDependencies": {}, - "dependencies": { - "@serenity-js/core": "^1.4.0" - } -} diff --git a/packages/integration-testing/register.js b/packages/integration-testing/register.js deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/packages/integration-testing/spec/spawner.spec.ts b/packages/integration-testing/spec/spawner.spec.ts deleted file mode 100644 index 128a7972aaa..00000000000 --- a/packages/integration-testing/spec/spawner.spec.ts +++ /dev/null @@ -1,4 +0,0 @@ -describe('Spawner', () => { - - it('spawns a process'); -}); diff --git a/packages/integration-testing/src/child_process_reporter.ts b/packages/integration-testing/src/child_process_reporter.ts deleted file mode 100644 index e1d6a10a9b4..00000000000 --- a/packages/integration-testing/src/child_process_reporter.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { DomainEvent } from '@serenity-js/core/lib/domain'; -import { StageCrewMember } from '@serenity-js/core/lib/stage'; - -export class ChildProcessReporter implements StageCrewMember { - constructor() { - this.enableSerialisationOfErrors(); - } - - assignTo(stage) { - stage.manager.registerInterestIn([ DomainEvent ], this); - } - - notifyOf(event) { - process.send(event); - } - - private enableSerialisationOfErrors() { - if (! ('toJSON' in Error.prototype)) { - Object.defineProperty(Error.prototype, 'toJSON', { - value: function() { // tslint:disable-line:object-literal-shorthand needed for `this` to work - const alt = {}; - - Object.getOwnPropertyNames(this).forEach(function(key) { - alt[key] = this[key]; - }, this); - - return alt; - }, - configurable: true, - writable: true, - }); - } - } -} - -export function childProcessReporter() { - return new ChildProcessReporter(); -} diff --git a/packages/integration-testing/src/event_picker.ts b/packages/integration-testing/src/event_picker.ts deleted file mode 100644 index 07c4e0ccb1f..00000000000 --- a/packages/integration-testing/src/event_picker.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { DomainEvent } from '@serenity-js/core/lib/domain'; - -export const lastOf = (type: typeof DomainEvent, events: Array>) => events.filter(e => e instanceof type).pop(); diff --git a/packages/integration-testing/src/index.ts b/packages/integration-testing/src/index.ts deleted file mode 100644 index 38a2b64b16d..00000000000 --- a/packages/integration-testing/src/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export * from './child_process_reporter'; -export * from './event_picker'; -export * from './spawner'; diff --git a/packages/integration-testing/src/spawner.ts b/packages/integration-testing/src/spawner.ts deleted file mode 100644 index bff9419aff8..00000000000 --- a/packages/integration-testing/src/spawner.ts +++ /dev/null @@ -1,73 +0,0 @@ -import { - ActivityFinished, - ActivityStarts, - DomainEvent, - Outcome, - RecordedActivity, - RecordedScene, - SceneFinished, - SceneStarts, - Tag, -} from '@serenity-js/core/lib/domain'; - -import { ForkOptions } from 'child_process'; - -import childProcess = require('child_process'); - -export class Spawned { - messages: any[] = []; - result: PromiseLike; - - constructor(pathToScript: string, args: string[], options: ForkOptions) { - - const spawned = childProcess.fork(pathToScript, args, options); - - spawned.on('message', event => this.messages.push(deserialised(event))); - - this.result = new Promise( (resolve, reject) => { - spawned.on('close', exitCode => { - if (exitCode !== 0) { - reject(exitCode); - } else { - resolve(0); - } - }); - }); - } -} - -function deserialised(event: any): DomainEvent { - const tagsFrom = (tags: Tag[]) => tags.map(_ => new Tag(_.type, _.values)), - scene = ({ name, category, location, tags, id }: RecordedScene): RecordedScene => new RecordedScene(name, category, location, tagsFrom(tags), id), - activity = ({ name, location, id }: RecordedActivity): RecordedActivity => new RecordedActivity(name, location, id), - outcome = (type: (T) => T, { subject, result, error }: Outcome) => new Outcome(type(subject), result, error); - - switch (event.type) { - case 'SceneStarts': - return new SceneStarts( - scene(event.value), - event.timestamp, - ); - case 'ActivityStarts': - return new ActivityStarts( - activity(event.value), - event.timestamp, - ); - case 'ActivityFinished': - return new ActivityFinished( - outcome(activity, event.value), - event.timestamp, - ); - case 'SceneFinished': - return new SceneFinished( - outcome(scene, event.value), - event.timestamp, - ); - default: - return event; - } -} - -export function spawner(pathToScript: string, options?: ForkOptions) { - return (...args: string[]) => new Spawned(pathToScript, args, options); -}; diff --git a/packages/integration-testing/tsconfig.json b/packages/integration-testing/tsconfig.json deleted file mode 100644 index 422e9cd214c..00000000000 --- a/packages/integration-testing/tsconfig.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true, - "outDir": "./lib" - }, - - "include": [ - "src/**/*.ts" - ], - "exclude": [ - "features", - "spec", - "node_modules" - ] -} \ No newline at end of file diff --git a/packages/mocha/.gitignore b/packages/mocha/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/packages/mocha/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/packages/mocha/.npmignore b/packages/mocha/.npmignore deleted file mode 100644 index a6dbf36ff16..00000000000 --- a/packages/mocha/.npmignore +++ /dev/null @@ -1,16 +0,0 @@ -# Node -node_modules -*.log -.npmignore -npm-shrinkwrap.json - -# Build artifacts -.nyc_output -staging -target - -# Specs -spec -mocha.opts -tsconfig*.json -tslint.json diff --git a/packages/mocha/LICENSE.md b/packages/mocha/LICENSE.md deleted file mode 100644 index 9c8f3ea0871..00000000000 --- a/packages/mocha/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - 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. \ No newline at end of file diff --git a/packages/mocha/NOTICE.md b/packages/mocha/NOTICE.md deleted file mode 100644 index 24c0543b6ba..00000000000 --- a/packages/mocha/NOTICE.md +++ /dev/null @@ -1 +0,0 @@ -Copyright 2016- Jan Molak, smartcode ltd. diff --git a/packages/mocha/README.md b/packages/mocha/README.md deleted file mode 100644 index 6626fccba68..00000000000 --- a/packages/mocha/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Serenity/JS - -Serenity/JS is a node.js library designed to make acceptance and regression testing of modern web applications -faster, more collaborative and easier to scale. - -Find out more at [serenity-js.org](http://serenity-js.org)! diff --git a/packages/mocha/index.js b/packages/mocha/index.js deleted file mode 100644 index 486e5439f29..00000000000 --- a/packages/mocha/index.js +++ /dev/null @@ -1,3 +0,0 @@ -'use strict'; - -module.exports = require('./lib/index'); diff --git a/packages/mocha/mocha.opts b/packages/mocha/mocha.opts deleted file mode 100644 index de28311a70a..00000000000 --- a/packages/mocha/mocha.opts +++ /dev/null @@ -1,2 +0,0 @@ ---compilers ts:ts-node/register ---reporter spec diff --git a/packages/mocha/package.json b/packages/mocha/package.json deleted file mode 100644 index cf8a1370f8d..00000000000 --- a/packages/mocha/package.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "name": "@serenity-js/mocha", - "version": "1.0.0", - "description": "Serenity/JS reporter for the Mocha test framework", - "author": "Jan Molak ", - "homepage": "http://serenity-js.org", - "license": "Apache-2.0", - "config": { - "access": "public" - }, - "main": "lib/register.js", - "typings": "lib/index.d.ts", - "keywords": [ - "serenity-js", - "mocha", - "tdd", - "bdd", - "test", - "testing" - ], - "scripts": { - "clean": "rimraf lib", - "lint": "tslint --project tsconfig.json --config ../../tslint.json --format stylish", - "test": "nyc --report-dir ../../target/coverage/mocha mocha --opts ../../mocha.opts 'spec/*.spec.ts'", - "package": "tsc --project tsconfig.json", - "verify": "npm run clean && npm run lint && npm test && npm run package" - }, - "repository": { - "type": "git", - "url": "https://github.com/jan-molak/serenity-js.git" - }, - "bugs": { - "url": "https://github.com/jan-molak/serenity-js/issues" - }, - "engines": { - "node": ">= 6.9.x", - "npm": ">= 3" - }, - "peerDependencies": { - "mocha": ">= 3.5.3" - }, - "devDependencies": { - "@serenity-js/integration-testing": "*" - }, - "dependencies": { - "@serenity-js/core": "^1.4.0" - }, - "nyc": { - "include": [ - "src/*.ts", - "src/**/*.ts" - ], - "exclude": [ - "lib", - "node_modules", - "spec" - ], - "extension": [ - ".ts" - ], - "require": [ - "ts-node/register" - ], - "reporter": [ - "json", - "text-summary", - "html" - ], - "cache": true, - "all": true - } -} diff --git a/packages/mocha/spec/examples/results.spec.ts b/packages/mocha/spec/examples/results.spec.ts deleted file mode 100644 index bb9179ad7f5..00000000000 --- a/packages/mocha/spec/examples/results.spec.ts +++ /dev/null @@ -1,53 +0,0 @@ -import { expect } from '../expect'; - -describe ('Integration with Mocha', () => { - - describe ('A sample test that', () => { - - it ('passes', () => { - expect('pass').to.equal('pass'); - }); - - it ('fails due to an AssertionError', () => { - expect('pass').to.equal('fail'); - }); - - it ('fails due to an async AssertionError', () => { - return expect(Promise.resolve('async pass')).to.eventually.equal('async fail'); - }); - - it ('is pending'); - - xit ('is skipped', () => { - expect('pass').to.equal('fail'); - }); - - it ('times out', function(done) { - this.timeout(5); - - setTimeout(done, 100); - }); - - it ('fails with an error', () => { - throw new Error('Expected problem'); - }); - - it ('asynchronously fails with an error', () => Promise.reject(new Error('Expected async problem'))); - }); - - describe ('A test with both setup and teardown that', () => { - - beforeEach(() => { - // setup - }); - - it ('passes', () => { - expect('pass').to.equal('pass'); - }); - - afterEach(() => { - // teardown - }); - }); - -}); diff --git a/packages/mocha/spec/expect.ts b/packages/mocha/spec/expect.ts deleted file mode 100644 index b2a26f30965..00000000000 --- a/packages/mocha/spec/expect.ts +++ /dev/null @@ -1,6 +0,0 @@ -const chai = require('chai'); -const chaiAsPromised = require('chai-as-promised'); - -chai.use(chaiAsPromised); - -export const expect = chai.expect; diff --git a/packages/mocha/spec/mocha/configure.ts b/packages/mocha/spec/mocha/configure.ts deleted file mode 100644 index c42cd7b56e5..00000000000 --- a/packages/mocha/spec/mocha/configure.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { serenity } from '@serenity-js/core'; -import { consoleReporter } from '@serenity-js/core/lib/reporting/console_reporter'; -import { childProcessReporter } from '@serenity-js/integration-testing'; - -serenity.configure({ - crew: [ - // consoleReporter(), - childProcessReporter(), - ], -}); diff --git a/packages/mocha/spec/mocha/last_of.ts b/packages/mocha/spec/mocha/last_of.ts deleted file mode 100644 index aea32118543..00000000000 --- a/packages/mocha/spec/mocha/last_of.ts +++ /dev/null @@ -1,4 +0,0 @@ -// import { lastOf } from '@serenity-js/integration-testing'; // todo: upgrade TS to support this -import { DomainEvent } from '@serenity-js/core/lib/domain'; - -export const lastOf = (type: typeof DomainEvent, events: Array>) => events.filter(e => e instanceof type).pop(); diff --git a/packages/mocha/spec/mocha/spawner.ts b/packages/mocha/spec/mocha/spawner.ts deleted file mode 100644 index c2ec22e4581..00000000000 --- a/packages/mocha/spec/mocha/spawner.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { spawner } from '@serenity-js/integration-testing'; - -const node_modules = `${__dirname}/../../node_modules`; - -const tsNodeSpawner = spawner( - `${node_modules}/.bin/_mocha`, - { cwd: `${__dirname}/../`, silent: false }, -); - -export const mocha = (...params) => tsNodeSpawner( - '--require', 'ts-node/register', - '--require', './mocha/configure.ts', - '--reporter', `${__dirname}/../../src/index.ts`, - ...params, - './examples/*.spec.ts', -); diff --git a/packages/mocha/spec/recognises_scenario_results.spec.ts b/packages/mocha/spec/recognises_scenario_results.spec.ts deleted file mode 100644 index 72c8ccf116f..00000000000 --- a/packages/mocha/spec/recognises_scenario_results.spec.ts +++ /dev/null @@ -1,165 +0,0 @@ -import { Result, SceneFinished, SceneStarts } from '@serenity-js/core/lib/domain'; - -import { expect } from './expect'; -import { lastOf } from './mocha/last_of'; -import { mocha } from './mocha/spawner'; - -describe('When working with Mocha', function() { - - this.timeout(10 * 1000); - - describe('Serenity/JS', () => { - - it ('reports passing scenarios', () => { - const spawned = mocha('--grep', 'A sample test that passes'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.SUCCESS]); - }); - }); - - it ('reports pending scenarios', () => { - const spawned = mocha('--grep', 'A sample test that is pending'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it ('reports skipped scenarios', () => { - const spawned = mocha('--grep', 'A sample test that is skipped'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it('reports sync scenarios failing due to an AssertionError', () => { - const spawned = mocha('--grep', 'A sample test that fails due to an AssertionError'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.FAILURE]); - }); - }); - - it('reports async scenarios failing due to an AssertionError', () => { - const spawned = mocha('--grep', 'A sample test that fails due to an async AssertionError'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.FAILURE]); - expect(event.value.error).to.deep.equal({ - actual: 'async pass', - expected: 'async fail', - message: 'expected \'async pass\' to equal \'async fail\'', - name: 'AssertionError', - showDiff: true, - }); - }); - }); - - it('reports scenarios that timed out', () => { - - const spawned = mocha('--grep', 'A sample test that times out'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.ERROR]); - expect(event.value.error.message).to.match(/Timeout of 5ms exceeded./); - }); - }); - - it('reports scenarios that failed with an error', () => { - - const spawned = mocha('--grep', 'A sample test that fails with an error'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.ERROR]); - expect(event.value.error.message).to.match(/Expected problem/); - }); - }); - - it('reports scenarios that failed with an error asynchronously', () => { - - const spawned = mocha('--grep', 'A sample test that asynchronously fails with an error'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.ERROR]); - expect(event.value.error.message).to.match(/Expected async problem/); - }); - }); - - it ('recognises the name of the feature under test (the outer-most `describe`)', () => { - const spawned = mocha('--grep', 'A sample test that passes'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const sceneStarts = lastOf(SceneStarts, spawned.messages); - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneStarts.value.category).to.equal('Integration with Mocha'); - expect(sceneFinished.value.subject.category).to.equal('Integration with Mocha'); - }); - }); - - it ('recognises the name of the scenario', () => { - const spawned = mocha('--grep', 'A sample test that passes'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const sceneStarts = lastOf(SceneStarts, spawned.messages); - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneStarts.value.name).to.equal('A sample test that passes'); - expect(sceneFinished.value.subject.name).to.equal('A sample test that passes'); - }); - }); - - it ('treats a scenario with setup and teardown just like any other scenario', () => { - const spawned = mocha('--grep', 'A test with both setup and teardown that passes'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(2); - - const sceneStarts = lastOf(SceneStarts, spawned.messages); - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneStarts.value.name).to.equal('A test with both setup and teardown that passes'); - expect(sceneFinished.value.subject.name).to.equal('A test with both setup and teardown that passes'); - }); - }); - }); -}); - diff --git a/packages/mocha/src/index.ts b/packages/mocha/src/index.ts deleted file mode 100644 index f2609a51d85..00000000000 --- a/packages/mocha/src/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { SerenityMochaReporter } from './reporter'; - -export = SerenityMochaReporter; diff --git a/packages/mocha/src/model.ts b/packages/mocha/src/model.ts deleted file mode 100644 index 27a337c31bb..00000000000 --- a/packages/mocha/src/model.ts +++ /dev/null @@ -1,100 +0,0 @@ -import { Outcome, RecordedScene, Result, SceneFinished, SceneStarts } from '@serenity-js/core/lib/domain'; - -export const startOf = (scenario: Scenario) => new SceneStarts(new MochaScene(scenario)); -export const endOf = (scenario: ExecutedScenario) => new SceneFinished(new Outcome(new MochaScene(scenario), finalStateOf(scenario), scenario.err)); -export const isPending = (scenario: ExecutedScenario) => finalStateOf(scenario) === Result.PENDING; - -export interface TestError { - name: string; - message: string; - showDiff: boolean; - actual: string; - expected: string; - stack: string; -} - -export interface Scenario { - title: string; - async: number; - sync: boolean; - timedOut: boolean; - pending: boolean; - type: string; - file: string; - parent: any; - ctx: any; - - body(): string; - fullTitle(): string; -} - -export interface ExecutedScenario extends Scenario { - time: any; - duration: number; - state: string; - speed: string; - err?: TestError; -} - -class MochaScene extends RecordedScene { - constructor(scenario: Scenario) { - super( - nameOf(scenario), - categoryOf(scenario), - { path: scenario.file }, - [], - scenario.fullTitle(), - ); - } -} - -function finalStateOf(scenario: ExecutedScenario): Result { - - if (scenario.pending) { - return Result.PENDING; - } - - if (scenario.state === 'passed') { - return Result.SUCCESS; - } - - if (timedOut(scenario) || hasErrors(scenario)) { - return Result.ERROR; - } - - if (scenario.state === 'failed') { - return Result.FAILURE; - } - - return Result.COMPROMISED; -} - -function timedOut(scenario: ExecutedScenario) { - // Mocha sets the `timedOut` flag *after* notifying the reporter of a test failure, hence the regex check. - return scenario.timedOut || (scenario.err && /^Timeout.*exceeded/.test(scenario.err.message)); -} - -function hasErrors(scenario: ExecutedScenario) { - return scenario.err && scenario.err.constructor && ! /AssertionError/.test(scenario.err.constructor.name); -} - -interface ScenarioOrSuite { - title: string; - parent: ScenarioOrSuite; -} - -function fullNameOf(scenario: ScenarioOrSuite) { - return !! scenario.parent - ? `${ fullNameOf(scenario.parent) } ${ scenario.title }`.trim() - : scenario.title; -} - -function nameOf(scenario: ScenarioOrSuite) { - return fullNameOf(scenario).substring(categoryOf(scenario).length).trim(); -} - -function categoryOf(scenario: ScenarioOrSuite) { - return !! scenario.parent && scenario.parent.title.trim() !== '' - ? categoryOf(scenario.parent) - : scenario.title; -} diff --git a/packages/mocha/src/reporter.ts b/packages/mocha/src/reporter.ts deleted file mode 100644 index c035b98af02..00000000000 --- a/packages/mocha/src/reporter.ts +++ /dev/null @@ -1,19 +0,0 @@ -import mocha = require('mocha'); -import { serenity } from '@serenity-js/core'; -import { endOf, ExecutedScenario, isPending, Scenario, startOf } from './model'; - -export function SerenityMochaReporter(runner) { - mocha.reporters.Base.call(this, runner); - - runner.on('test', (scenario: Scenario) => { - serenity.notify(startOf(scenario)); - }); - - runner.on('test end', (scenario: ExecutedScenario) => { - if (isPending(scenario)) { - serenity.notify(startOf(scenario)); - } - - serenity.notify(endOf(scenario)); - }); -} diff --git a/packages/mocha/tsconfig.json b/packages/mocha/tsconfig.json deleted file mode 100644 index 422e9cd214c..00000000000 --- a/packages/mocha/tsconfig.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true, - "outDir": "./lib" - }, - - "include": [ - "src/**/*.ts" - ], - "exclude": [ - "features", - "spec", - "node_modules" - ] -} \ No newline at end of file diff --git a/packages/rest/.gitignore b/packages/rest/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/packages/rest/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/packages/rest/.npmignore b/packages/rest/.npmignore deleted file mode 100644 index a6dbf36ff16..00000000000 --- a/packages/rest/.npmignore +++ /dev/null @@ -1,16 +0,0 @@ -# Node -node_modules -*.log -.npmignore -npm-shrinkwrap.json - -# Build artifacts -.nyc_output -staging -target - -# Specs -spec -mocha.opts -tsconfig*.json -tslint.json diff --git a/packages/rest/LICENSE.md b/packages/rest/LICENSE.md deleted file mode 100644 index 9c8f3ea0871..00000000000 --- a/packages/rest/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - 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. \ No newline at end of file diff --git a/packages/rest/NOTICE.md b/packages/rest/NOTICE.md deleted file mode 100644 index 24c0543b6ba..00000000000 --- a/packages/rest/NOTICE.md +++ /dev/null @@ -1 +0,0 @@ -Copyright 2016- Jan Molak, smartcode ltd. diff --git a/packages/rest/README.md b/packages/rest/README.md deleted file mode 100644 index 6626fccba68..00000000000 --- a/packages/rest/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Serenity/JS - -Serenity/JS is a node.js library designed to make acceptance and regression testing of modern web applications -faster, more collaborative and easier to scale. - -Find out more at [serenity-js.org](http://serenity-js.org)! diff --git a/packages/rest/package.json b/packages/rest/package.json deleted file mode 100644 index fecc5add019..00000000000 --- a/packages/rest/package.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "name": "@serenity-js/rest", - "version": "1.1.0", - "description": "Enables Serenity/JS test scenarios to integrate with REST-based HTTP APIs.", - "author": "Kenny Baas , Jan Molak ", - "homepage": "http://serenity-js.org", - "license": "Apache-2.0", - "config": { - "access": "public" - }, - "main": "lib/index.js", - "typings": "lib/index.d.ts", - "keywords": [ - "serenity-js", - "screenplay", - "bdd", - "tdd", - "test", - "testing", - "rest", - "http", - "axios" - ], - "scripts": { - "clean": "rimraf lib", - "lint": "tslint --project tsconfig.json --config ../../tslint.json --format stylish", - "test": "nyc --report-dir ../../target/coverage/rest mocha --opts ../../mocha.opts 'spec/**/*.spec.*'", - "package": "tsc --project tsconfig.json", - "verify": "npm run clean && npm run lint && npm test && npm run package" - }, - "devDependencies": { - "@types/axios": "0.14.0", - "axios-mock-adapter": "1.10.0" - }, - "dependencies": { - "@serenity-js/core": "^1.5.4", - "axios": "0.17.1" - }, - "repository": { - "type": "git", - "url": "https://github.com/jan-molak/serenity-js.git" - }, - "bugs": { - "url": "https://github.com/jan-molak/serenity-js/issues" - }, - "engines": { - "node": ">= 6.9.x", - "npm": ">= 3" - }, - "nyc": { - "include": [ - "src/*.ts", - "src/**/*.ts" - ], - "exclude": [ - "*.js", - "lib", - "spec", - "staging", - "node_modules" - ], - "extension": [ - ".ts" - ], - "require": [ - "ts-node/register" - ], - "reporter": [ - "json", - "text-summary" - ], - "cache": true, - "all": true - } -} diff --git a/packages/rest/spec/expect.ts b/packages/rest/spec/expect.ts deleted file mode 100644 index 95c6bfc4055..00000000000 --- a/packages/rest/spec/expect.ts +++ /dev/null @@ -1,8 +0,0 @@ -import chai = require('chai'); -import chaiAsPromised = require('chai-as-promised'); -import sinonChai = require('sinon-chai'); - -chai.use(chaiAsPromised); -chai.use(sinonChai); - -export const expect = chai.expect; diff --git a/packages/rest/spec/screenplay/abilities/call_an_api.spec.ts b/packages/rest/spec/screenplay/abilities/call_an_api.spec.ts deleted file mode 100644 index 2944173f80f..00000000000 --- a/packages/rest/spec/screenplay/abilities/call_an_api.spec.ts +++ /dev/null @@ -1,174 +0,0 @@ -import 'mocha'; - -import axios, { AxiosInstance } from 'axios'; -import AxiosMockAdapter = require('axios-mock-adapter'); - -import { CallAnApi } from '../../../src/screenplay/abilities'; -import { expect } from '../../expect'; - -describe('Abilities', () => { - - const baseURL = 'https://dum.my'; - - describe('Call an Api', () => { - const axiosInstance: AxiosInstance = axios.create({baseURL}); - - const dummyApi = new AxiosMockAdapter(axiosInstance); - - const callAnApi = CallAnApi.using(axiosInstance); - - after(() => dummyApi.restore()); - - describe('performs a get on a resource and gets 200', () => { - - const resource = '/get200'; - - dummyApi - .onGet(resource) - .reply(200, { - username: '1337', - }); - - before(() => expect(callAnApi.get(resource)).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 200', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(200))); - it('and LastResponse has data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.not.be.empty)); - }); - - describe('performs a get on a resource and gets 404', () => { - const resource = '/get404'; - - dummyApi - .onGet(resource) - .reply(404); - - before(() => expect(callAnApi.get(resource)).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 404', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(404))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - - describe('performs a post on a resource and gets 201', () => { - const resource = '/post201'; - - dummyApi - .onPost(resource, { - username: '1337', - }) - .reply(201); - - before(() => expect(callAnApi.post(resource, {username: '1337'})).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 201', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(201))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - - describe('performs a post on a resource and gets 403', () => { - const resource = '/post403'; - - dummyApi - .onPost(resource) - .reply(403); - - before(() => expect(callAnApi.post(resource, {username: '1337'})).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 403', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(403))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - - describe('performs a delete on a resource and gets 200', () => { - - const resource = '/delete200'; - - dummyApi - .onDelete(resource) - .reply(200, { - username: '1337', - }); - - before(() => expect(callAnApi.delete(resource)).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 200', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(200))); - it('and LastResponse has data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.not.be.empty)); - }); - - describe('performs a delete on a resource and gets 404', () => { - const resource = '/delete404'; - - dummyApi - .onDelete(resource) - .reply(404); - - before(() => expect(callAnApi.delete(resource)).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 404', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(404))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - - describe('performs a put on a resource and gets 200', () => { - - const resource = '/put200'; - - dummyApi - .onPut(resource) - .reply(200, { - username: '1337', - }); - - before(() => expect(callAnApi.put(resource, {username: '1337'})).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 200', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(200))); - it('and LastResponse has data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.not.be.empty)); - }); - - describe('performs a put on a resource and gets 404', () => { - const resource = '/put404'; - - dummyApi - .onPut(resource) - .reply(404); - - before(() => expect(callAnApi.put(resource, {username: '1337'})).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 404', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(404))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - - describe('performs a patch on a resource and gets 200', () => { - - const resource = '/patch200'; - - dummyApi - .onPatch(resource, { username: '1337' }) - .reply(200); - - before(() => expect(callAnApi.patch(resource, { username: '1337' })).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 200', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(200))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - - describe('performs a patch on a resource and gets 404', () => { - const resource = '/patch404'; - - dummyApi - .onPatch(resource, { username: '1337' }) - .reply(404); - - before(() => expect(callAnApi.put(resource, { username: '1337' })).to.eventually.be.fulfilled); - - it('and eventually has a LastResponse', () => expect(callAnApi.getLastResponse()).to.eventually.not.be.undefined); - it('and LastResponse status is 404', () => callAnApi.getLastResponse().then(response => expect(response.status).to.equal(404))); - it('and LastResponse has no data', () => callAnApi.getLastResponse().then(response => expect(response.data).to.be.undefined)); - }); - }); -}); diff --git a/packages/rest/spec/screenplay/interactions/delete.spec.ts b/packages/rest/spec/screenplay/interactions/delete.spec.ts deleted file mode 100644 index c27cee7a776..00000000000 --- a/packages/rest/spec/screenplay/interactions/delete.spec.ts +++ /dev/null @@ -1,39 +0,0 @@ -import sinon = require('sinon'); -import 'mocha'; -import { CallAnApi } from '../../../src/screenplay/abilities'; -import { Delete } from '../../../src/screenplay/interactions'; - -import { Actor } from '@serenity-js/core/lib/screenplay'; - -import { expect } from '../../expect'; - -describe('Interactions', () => { - const baseUrl = 'https://dum.my'; - - describe('delete resource', () => { - let spyAs, spyDelete; - const callAnApi = CallAnApi.at(baseUrl); - const actor = Actor.named('James').whoCan(callAnApi), - resource = '/delete'; - - before(() => { - spyAs = sinon.spy(CallAnApi, 'as'); - spyDelete = sinon.spy(callAnApi, 'delete'); - }); - - beforeEach(() => expect(Delete.resource(resource).performAs(actor)).to.eventually.be.fulfilled); - - it('should perform as the actor.', () => { - expect(spyAs).to.have.been.calledOnce; - }); - - it('should perform a Delete on the resource', () => { - expect(spyDelete).to.have.been.calledWith(resource); - }); - - after(() => { - spyAs.restore(); - spyDelete.restore(); - }); - }); -}); diff --git a/packages/rest/spec/screenplay/interactions/get.spec.ts b/packages/rest/spec/screenplay/interactions/get.spec.ts deleted file mode 100644 index 3effa806755..00000000000 --- a/packages/rest/spec/screenplay/interactions/get.spec.ts +++ /dev/null @@ -1,40 +0,0 @@ -import sinon = require('sinon'); -import 'mocha'; -import { CallAnApi } from '../../../src/screenplay/abilities'; -import { Get } from '../../../src/screenplay/interactions'; - -import { Actor } from '@serenity-js/core/lib/screenplay'; - -import { expect } from '../../expect'; - -describe('Interactions', () => { - const baseUrl = 'https://dum.my'; - - describe('Get resource', () => { - let spyAs, spyGet; - const callAnApi = CallAnApi.at(baseUrl); - const actor = Actor.named('James').whoCan(callAnApi), - resource = '/get'; - - before(() => { - spyAs = sinon.spy(CallAnApi, 'as'); - spyGet = sinon.spy(callAnApi, 'get'); - }); - - beforeEach(() => expect(Get.resource(resource).performAs(actor)).to.eventually.be.fulfilled); - - it('should perform as the actor.', () => { - expect(spyAs).to.have.been.calledOnce; - }); - - it('should perform a Get on the resource', () => { - expect(spyGet).to.have.been.calledWith(resource); - }); - - after(() => { - spyAs.restore(); - spyGet.restore(); - }); - - }); -}); diff --git a/packages/rest/spec/screenplay/interactions/patch.spec.ts b/packages/rest/spec/screenplay/interactions/patch.spec.ts deleted file mode 100644 index 889d5ccabea..00000000000 --- a/packages/rest/spec/screenplay/interactions/patch.spec.ts +++ /dev/null @@ -1,40 +0,0 @@ -import sinon = require('sinon'); -import 'mocha'; -import { CallAnApi } from '../../../src/screenplay/abilities'; -import { Patch } from '../../../src/screenplay/interactions'; - -import { Actor } from '@serenity-js/core/lib/screenplay'; - -import { expect } from '../../expect'; - -describe('Interactions', () => { - const baseUrl = 'https://dum.my'; - - describe('Patch resource', () => { - let spyAs, spyPatch; - const callAnApi = CallAnApi.at(baseUrl); - const actor = Actor.named('James').whoCan(callAnApi), - resource = '/patch'; - const item = {username: '1337'}; - - before(() => { - spyAs = sinon.spy(CallAnApi, 'as'); - spyPatch = sinon.spy(callAnApi, 'patch'); - }); - - beforeEach(() => expect(Patch.resource(resource).with(item).performAs(actor)).to.eventually.fulfilled); - - it('should perform as the actor.', () => { - expect(spyAs).to.have.been.calledOnce; - }); - - it('should perform a Patch on the resource', () => { - expect(spyPatch).to.have.been.calledWith(resource, item); - }); - - after(() => { - spyAs.restore(); - spyPatch.restore(); - }); - }); -}); diff --git a/packages/rest/spec/screenplay/interactions/post.spec.ts b/packages/rest/spec/screenplay/interactions/post.spec.ts deleted file mode 100644 index 90532aa623c..00000000000 --- a/packages/rest/spec/screenplay/interactions/post.spec.ts +++ /dev/null @@ -1,41 +0,0 @@ -import sinon = require('sinon'); -import 'mocha'; -import {CallAnApi} from '../../../src/screenplay/abilities'; -import {Post} from '../../../src/screenplay/interactions'; - -import {Actor} from '@serenity-js/core/lib/screenplay'; - -import {expect} from '../../expect'; - -describe('Interactions', () => { - const baseUrl = 'https://dum.my'; - - describe('Post resource', () => { - let spyAs, spyPost; - const callAnApi = CallAnApi.at(baseUrl); - const actor = Actor.named('James').whoCan(callAnApi), - resource = '/post'; - const item = { username: '1337'}; - - before(() => { - spyAs = sinon.spy(CallAnApi, 'as'); - spyPost = sinon.spy(callAnApi, 'post'); - }); - - beforeEach(() => expect(Post.item(item).on(resource).performAs(actor)).to.eventually.be.fulfilled); - - it('should perform as the actor.', () => { - expect(spyAs).to.have.been.calledOnce; - }); - - it('should perform a Post on the resource', () => { - expect(spyPost).to.have.been.calledWith(resource, item); - }); - - after(() => { - spyAs.restore(); - spyPost.restore(); - }); - - }); -}); diff --git a/packages/rest/spec/screenplay/interactions/put.spec.ts b/packages/rest/spec/screenplay/interactions/put.spec.ts deleted file mode 100644 index 2c006382eca..00000000000 --- a/packages/rest/spec/screenplay/interactions/put.spec.ts +++ /dev/null @@ -1,41 +0,0 @@ -import sinon = require('sinon'); -import 'mocha'; -import { CallAnApi } from '../../../src/screenplay/abilities'; -import { Put } from '../../../src/screenplay/interactions'; - -import { Actor } from '@serenity-js/core/lib/screenplay'; - -import { expect } from '../../expect'; - -describe('Interactions', () => { - const baseUrl = 'https://dum.my'; - - describe('put resource', () => { - let spyAs, spyPut; - const callAnApi = CallAnApi.at(baseUrl); - const actor = Actor.named('James').whoCan(callAnApi), - resource = '/put'; - const item = { username: '1337' }; - - before(() => { - spyAs = sinon.spy(CallAnApi, 'as'); - spyPut = sinon.spy(callAnApi, 'put'); - }); - - beforeEach(() => expect(Put.item(item).on(resource).performAs(actor)).to.eventually.be.fulfilled); - - it('should perform as the actor.', () => { - expect(spyAs).to.have.been.calledOnce; - }); - - it('should perform a Put on the resource', () => { - expect(spyPut).to.have.been.calledWith(resource, item); - }); - - after(() => { - spyAs.restore(); - spyPut.restore(); - }); - - }); -}); diff --git a/packages/rest/src/index.ts b/packages/rest/src/index.ts deleted file mode 100644 index 92e6665d356..00000000000 --- a/packages/rest/src/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './screenplay'; diff --git a/packages/rest/src/screenplay/abilities/call_an_api.ts b/packages/rest/src/screenplay/abilities/call_an_api.ts deleted file mode 100644 index 3f40c983d37..00000000000 --- a/packages/rest/src/screenplay/abilities/call_an_api.ts +++ /dev/null @@ -1,132 +0,0 @@ -import { Ability, UsesAbilities } from '@serenity-js/core/lib/screenplay'; -import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'; - -/** - * Call an Api is the ability to correspond with an Api by the npm package axios. - */ -export class CallAnApi implements Ability { - - private lastResponse: AxiosResponse; - - /** - * Ability to Call and api at a specified baseUrl - * Timeout is set to 1s and headers Accept application/json and application/xml - * - * @param {string} baseURL - * @returns {CallAnApi} - */ - static at(baseURL: string) { - const axiosInstance: AxiosInstance = axios.create({ - baseURL, - timeout: 2000, - headers: { Accept: 'application/json,application/xml' }, - }); - return new CallAnApi(axiosInstance); - } - - /** - * Ability to Call an Api with a given axios instance. - * - * @param {AxiosInstance} axiosInstance - * @returns {CallAnApi} - */ - static using(axiosInstance: AxiosInstance) { - return new CallAnApi(axiosInstance); - } - - /** - * Used to access the Actor's ability to CallAnApi from within the Interaction classes, such as GET or PUT - * - * @param actor - * @return {CallAnApi} - */ - static as(actor: UsesAbilities): CallAnApi { - return actor.abilityTo(CallAnApi); - } - - /** - * Send a GET request to a specified url. - * Response will be resolved and made available as lastResponse. - * - * @param {string} url - * @param {AxiosRequestConfig} config - * @returns {PromiseLike} - */ - get(url: string, config?: AxiosRequestConfig): PromiseLike { - return this.axiosInstance.get(url, config).then( - fulfilled => this.lastResponse = fulfilled, - rejected => this.lastResponse = rejected.response, - ); - } - - /** - * Call the api method post on the url. - * Response will be resolved and made available as lastResponse. - * - * @param {string} url - * @param data - * @param {AxiosRequestConfig} config - * @returns {PromiseLike} - */ - post(url: string, data?: any, config?: AxiosRequestConfig): PromiseLike { - return this.axiosInstance.post(url, data, config).then( - fulfilled => this.lastResponse = fulfilled, - rejected => this.lastResponse = rejected.response, - ); - } - - /** - * Send a DELETE request to a specified url. - * Every response will be resolved and put into the lastResponse. - * - * @param {string} url - * @param {AxiosRequestConfig} config - * @returns {PromiseLike} - */ - delete(url: string, config?: AxiosRequestConfig): PromiseLike { - return this.axiosInstance.delete(url, config).then( - fulfilled => this.lastResponse = fulfilled, - rejected => this.lastResponse = rejected.response, - ); - } - - /** - * PATCH the resource at a specified url. - * Response will be resolved and made available as lastResponse. - * - * @param {string} url - * @param data - * @param {AxiosRequestConfig} config - * @returns {PromiseLike} - */ - patch(url: string, data?: any, config?: AxiosRequestConfig): PromiseLike { - return this.axiosInstance.patch(url, data, config).then( - fulfilled => this.lastResponse = fulfilled, - rejected => this.lastResponse = rejected.response, - ); - } - - /** - * Send a PUT request to a specified url. - * Response will be resolved and made available as lastResponse. - * - * @param {string} url - * @param data - * @param {AxiosRequestConfig} config - * @returns {PromiseLike} - */ - put(url: string, data?: any, config?: AxiosRequestConfig): PromiseLike { - return this.axiosInstance.put(url, data, config).then( - fulfilled => this.lastResponse = fulfilled, - rejected => this.lastResponse = rejected.response, - ); - } - - getLastResponse(): PromiseLike { - return Promise.resolve(this.lastResponse); - } - - constructor(private axiosInstance: AxiosInstance) { - } - -} diff --git a/packages/rest/src/screenplay/abilities/index.ts b/packages/rest/src/screenplay/abilities/index.ts deleted file mode 100644 index 46c199261b1..00000000000 --- a/packages/rest/src/screenplay/abilities/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './call_an_api'; diff --git a/packages/rest/src/screenplay/index.ts b/packages/rest/src/screenplay/index.ts deleted file mode 100644 index c0ccfc9c624..00000000000 --- a/packages/rest/src/screenplay/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export * from './abilities'; -export * from './interactions'; -export * from './questions'; diff --git a/packages/rest/src/screenplay/interactions/delete.ts b/packages/rest/src/screenplay/interactions/delete.ts deleted file mode 100644 index d4ba52e23ba..00000000000 --- a/packages/rest/src/screenplay/interactions/delete.ts +++ /dev/null @@ -1,16 +0,0 @@ -import {Interaction, UsesAbilities} from '@serenity-js/core/lib/screenplay'; -import {CallAnApi} from '../abilities'; - -export class Delete implements Interaction { - - static resource = (resource: string) => new Delete(resource); - - performAs(actor: UsesAbilities): PromiseLike { - return CallAnApi.as(actor).delete(this.resource); - } - - constructor(private resource: string) { - } - - toString = () => `#actor executes a DELETE on resource ${this.resource}`; -} diff --git a/packages/rest/src/screenplay/interactions/get.ts b/packages/rest/src/screenplay/interactions/get.ts deleted file mode 100644 index 4f79c8e9a83..00000000000 --- a/packages/rest/src/screenplay/interactions/get.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { Interaction, UsesAbilities } from '@serenity-js/core/lib/screenplay'; -import {CallAnApi} from '../abilities'; - -export class Get implements Interaction { - - static resource = (resource: string) => new Get(resource); - - performAs(actor: UsesAbilities): PromiseLike { - return CallAnApi.as(actor).get(this.resource); - } - - constructor(private resource: string) { } - - toString = () => `#actor executes a GET on resource ${this.resource}`; -} diff --git a/packages/rest/src/screenplay/interactions/index.ts b/packages/rest/src/screenplay/interactions/index.ts deleted file mode 100644 index 650fa660fee..00000000000 --- a/packages/rest/src/screenplay/interactions/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -export * from './delete'; -export * from './get'; -export * from './patch'; -export * from './post'; -export * from './put'; diff --git a/packages/rest/src/screenplay/interactions/patch.ts b/packages/rest/src/screenplay/interactions/patch.ts deleted file mode 100644 index 18562d28d31..00000000000 --- a/packages/rest/src/screenplay/interactions/patch.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { Interaction, UsesAbilities } from '@serenity-js/core/lib/screenplay'; -import { CallAnApi } from '../abilities'; - -export class Patch implements Interaction { - - static resource = (resource: string) => ({ with: (item: any) => new Patch(item, resource) }); - - performAs(actor: UsesAbilities): PromiseLike { - return CallAnApi.as(actor).patch(this.resource, this.item); - } - - constructor(private item: any, private resource: string) { - } - - toString = () => `#actor executes a PATCH on resource ${this.resource} with item: ${this.item}`; -} diff --git a/packages/rest/src/screenplay/interactions/post.ts b/packages/rest/src/screenplay/interactions/post.ts deleted file mode 100644 index 65bdc3bf224..00000000000 --- a/packages/rest/src/screenplay/interactions/post.ts +++ /dev/null @@ -1,16 +0,0 @@ -import {Interaction, UsesAbilities} from '@serenity-js/core/lib/screenplay'; -import {CallAnApi} from '../abilities'; - -export class Post implements Interaction { - - static item = (item: any) => ({ on: (resource: string) => new Post(item, resource) }); - - performAs(actor: UsesAbilities): PromiseLike { - return CallAnApi.as(actor).post(this.resource, this.item); - } - - constructor(private item: any, private resource: string) { - } - - toString = () => `#actor executes a POST on resource ${this.resource} with item: ${this.item}`; -} diff --git a/packages/rest/src/screenplay/interactions/put.ts b/packages/rest/src/screenplay/interactions/put.ts deleted file mode 100644 index 68efb16785e..00000000000 --- a/packages/rest/src/screenplay/interactions/put.ts +++ /dev/null @@ -1,16 +0,0 @@ -import {Interaction, UsesAbilities} from '@serenity-js/core/lib/screenplay'; -import {CallAnApi} from '../abilities'; - -export class Put implements Interaction { - - static item = (item: any) => ({ on: (resource: string) => new Put(item, resource) }); - - performAs(actor: UsesAbilities): PromiseLike { - return CallAnApi.as(actor).put(this.resource, this.item); - } - - constructor(private item: any, private resource: string) { - } - - toString = () => `#actor executes a PUT on resource ${this.resource} with item: ${this.item}`; -} diff --git a/packages/rest/src/screenplay/questions/index.ts b/packages/rest/src/screenplay/questions/index.ts deleted file mode 100644 index 602df0689f1..00000000000 --- a/packages/rest/src/screenplay/questions/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './last_response'; diff --git a/packages/rest/src/screenplay/questions/last_response.ts b/packages/rest/src/screenplay/questions/last_response.ts deleted file mode 100644 index 0ecb58d2720..00000000000 --- a/packages/rest/src/screenplay/questions/last_response.ts +++ /dev/null @@ -1,7 +0,0 @@ -import {Question} from '@serenity-js/core/lib/screenplay'; -import {AxiosResponse} from 'axios'; -import {CallAnApi} from '../abilities'; - -export const LastResponse = () => Question.about(`The Message`, actor => - CallAnApi.as(actor).getLastResponse() as PromiseLike, -); diff --git a/packages/rest/tsconfig.json b/packages/rest/tsconfig.json deleted file mode 100644 index a9782114334..00000000000 --- a/packages/rest/tsconfig.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": [ "es5", "es6" ], - "module": "commonjs", - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "sourceMap": true, - "declaration": true, - "outDir": "./lib" - }, - - "include": [ - "src/**/*.ts" - ], - "exclude": [ - "features", - "spec", - "node_modules" - ] -} diff --git a/packages/serenity-js/.gitignore b/packages/serenity-js/.gitignore deleted file mode 100644 index ec9d8ac66c4..00000000000 --- a/packages/serenity-js/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Node -node_modules -target/ -*.log - -# Build artifacts -.nyc_output -lib -staging \ No newline at end of file diff --git a/packages/serenity-js/.npmignore b/packages/serenity-js/.npmignore deleted file mode 100644 index a6dbf36ff16..00000000000 --- a/packages/serenity-js/.npmignore +++ /dev/null @@ -1,16 +0,0 @@ -# Node -node_modules -*.log -.npmignore -npm-shrinkwrap.json - -# Build artifacts -.nyc_output -staging -target - -# Specs -spec -mocha.opts -tsconfig*.json -tslint.json diff --git a/packages/serenity-js/LICENSE.md b/packages/serenity-js/LICENSE.md deleted file mode 100644 index 9c8f3ea0871..00000000000 --- a/packages/serenity-js/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - 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. \ No newline at end of file diff --git a/packages/serenity-js/NOTICE.md b/packages/serenity-js/NOTICE.md deleted file mode 100644 index 24c0543b6ba..00000000000 --- a/packages/serenity-js/NOTICE.md +++ /dev/null @@ -1 +0,0 @@ -Copyright 2016- Jan Molak, smartcode ltd. diff --git a/packages/serenity-js/README.md b/packages/serenity-js/README.md deleted file mode 100644 index 6626fccba68..00000000000 --- a/packages/serenity-js/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Serenity/JS - -Serenity/JS is a node.js library designed to make acceptance and regression testing of modern web applications -faster, more collaborative and easier to scale. - -Find out more at [serenity-js.org](http://serenity-js.org)! diff --git a/packages/serenity-js/package.json b/packages/serenity-js/package.json deleted file mode 100644 index b7edf7182ca..00000000000 --- a/packages/serenity-js/package.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "name": "serenity-js", - "version": "1.10.13", - "description": "Serenity/JS: Next generation acceptance testing library for modern web applications.", - "author": "Jan Molak ", - "homepage": "http://serenity-js.org", - "license": "Apache-2.0", - "main": "lib/index.js", - "typings": "lib/index.d.ts", - "keywords": [ - "protractor", - "mocha", - "cucumber", - "angular", - "tdd", - "bdd", - "test", - "selenium", - "webdriverjs", - "webdriver", - "testing" - ], - "scripts": { - "clean": "rimraf staging lib .nyc_output", - "pretest": "webdriver-manager update --standalone --versions.standalone=2.53.1 --gecko=false", - "test": "npm run spec", - "lint": "tslint --project tsconfig.json --config ../../tslint.json --format stylish", - "package": "tsc --project tsconfig-export.json", - "verify": "npm run clean && npm run lint && npm test && npm run package", - "rebuild": "npm run clean && npm run verify", - "spec:api": "nyc --report-dir ../../target/coverage/api mocha --opts ../../mocha.opts 'spec/api/**/*.spec.*'", - "spec:cookbook": "nyc --report-dir ../../target/coverage/cookbook protractor ./spec/protractor-cookbook.conf.js", - "spec:integration": "nyc --report-dir ../../target/coverage/integration mocha --opts ../../mocha.opts 'spec/integration/*/*.ts'", - "spec": "npm run spec:api && npm run spec:cookbook && npm run spec:integration" - }, - "peerDependencies": { - "protractor": "5.x" - }, - "dependencies": { - "@serenity-js/core": ">= 1.6.0", - "@types/selenium-webdriver": "2.53.39", - "co": "4.6.0", - "glob": "7.1.1", - "graceful-fs": "4.1.11", - "is-generator": "1.0.3", - "lodash": "^4.17.5", - "selenium-webdriver": "3.0.1", - "ts-md5": "1.2.0", - "util-arity": "1.1.0" - }, - "devDependencies": { - "@types/cucumber": "0.0.35", - "@types/express": "4.0.35", - "@types/glob": "5.0.30", - "@types/mock-fs": "3.6.30", - "@types/stacktrace-js": "0.0.30", - "chai-smoothie": "^0.2.0", - "cucumber": "1.3.2", - "express": "4.14.1", - "mock-fs": "4.4.1", - "protractor": "5.3.0" - }, - "repository": { - "type": "git", - "url": "https://github.com/jan-molak/serenity-js.git" - }, - "bugs": { - "url": "https://github.com/jan-molak/serenity-js/issues" - }, - "engines": { - "node": ">= 6.9.x", - "npm": ">= 3" - }, - "nyc": { - "include": [ - "src/*.ts", - "src/**/*.ts" - ], - "exclude": [ - "book", - "_book", - "*.js", - "docs", - "examples/**", - "lib", - "**/protractor.d.ts", - "spec", - "staging", - "node_modules" - ], - "extension": [ - ".ts" - ], - "require": [ - "ts-node/register" - ], - "reporter": [ - "json", - "text-summary" - ], - "cache": true, - "all": true - } -} diff --git a/packages/serenity-js/protractor.d.ts b/packages/serenity-js/protractor.d.ts deleted file mode 100644 index 22d4808f3a9..00000000000 --- a/packages/serenity-js/protractor.d.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './lib/screenplay-protractor'; diff --git a/packages/serenity-js/protractor.js b/packages/serenity-js/protractor.js deleted file mode 100644 index 42d3e9f1e61..00000000000 --- a/packages/serenity-js/protractor.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = require('./lib/screenplay-protractor'); diff --git a/packages/serenity-js/spec/api/resources/java_scenarios/jar_not_found/bin/java b/packages/serenity-js/spec/api/resources/java_scenarios/jar_not_found/bin/java deleted file mode 100755 index 9251b6d902f..00000000000 --- a/packages/serenity-js/spec/api/resources/java_scenarios/jar_not_found/bin/java +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env bash - ->&2 echo "Error: Unable to access jarfile" $2 -exit 1; diff --git a/packages/serenity-js/spec/api/resources/java_scenarios/java6/bin/java b/packages/serenity-js/spec/api/resources/java_scenarios/java6/bin/java deleted file mode 100755 index 2d74b81383a..00000000000 --- a/packages/serenity-js/spec/api/resources/java_scenarios/java6/bin/java +++ /dev/null @@ -1,17 +0,0 @@ -#!/usr/bin/env bash - ->&2 echo "Exception in thread "main" java.lang.UnsupportedClassVersionError: net/serenitybdd/cli/Serenity : Unsupported major.minor version 51.0" ->&2 echo " at java.lang.ClassLoader.defineClass1(Native Method)" ->&2 echo " at java.lang.ClassLoader.defineClassCond(ClassLoader.java:631)" ->&2 echo " at java.lang.ClassLoader.defineClass(ClassLoader.java:615)" ->&2 echo " at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:141)" ->&2 echo " at java.net.URLClassLoader.defineClass(URLClassLoader.java:283)" ->&2 echo " at java.net.URLClassLoader.access$000(URLClassLoader.java:58)" ->&2 echo " at java.net.URLClassLoader$1.run(URLClassLoader.java:197)" ->&2 echo " at java.security.AccessController.doPrivileged(Native Method)" ->&2 echo " at java.net.URLClassLoader.findClass(URLClassLoader.java:190)" ->&2 echo " at java.lang.ClassLoader.loadClass(ClassLoader.java:306)" ->&2 echo " at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:301)" ->&2 echo " at java.lang.ClassLoader.loadClass(ClassLoader.java:247)" - -exit 1; \ No newline at end of file diff --git a/packages/serenity-js/spec/api/resources/java_scenarios/noop/bin/java b/packages/serenity-js/spec/api/resources/java_scenarios/noop/bin/java deleted file mode 100755 index 5af177a8306..00000000000 --- a/packages/serenity-js/spec/api/resources/java_scenarios/noop/bin/java +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/env bash -echo $@ diff --git a/packages/serenity-js/spec/api/resources/java_scenarios/running_serenity/bin/java b/packages/serenity-js/spec/api/resources/java_scenarios/running_serenity/bin/java deleted file mode 100755 index 79530898f87..00000000000 --- a/packages/serenity-js/spec/api/resources/java_scenarios/running_serenity/bin/java +++ /dev/null @@ -1,32 +0,0 @@ -#!/usr/bin/env bash - -echo "-------------------------------" -echo "SERENITY COMMAND LINE INTERFACE" -echo "-------------------------------" -echo "Loading test outcomes from target/site/serenity" -echo "Writing aggregated report to target/site/serenity" -echo "" -echo "02:12:03.700 [main] DEBUG net.serenitybdd.cli.reporters.CLIOutcomeReportGenerator - Shutting down Test outcome reports generation" -echo "02:12:03.702 [main] DEBUG net.serenitybdd.cli.reporters.CLIOutcomeReportGenerator - HTML test reports generated in 33 ms" -echo "02:12:03.904 [main] DEBUG net.thucydides.core.reports.html.HtmlAggregateStoryReporter - Shutting down Test outcome reports generation" -echo "02:12:03.906 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.reports.FileSystemRequirmentsOutcomeFactory - Loaded requirements from file system = []" -echo "02:12:03.909 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Requirements found:[]" -echo "02:12:03.911 [pool-3-thread-1] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Requirements found:[]" -echo "02:12:04.158 [pool-3-thread-1] WARN net.thucydides.core.requirements.PackageRequirementsTagProvider - To generate correct requirements coverage reports you need to set the 'serenity.test.root' property to the package representing the top of your requirements hierarchy." -echo "02:12:04.158 [pool-3-thread-5] WARN net.thucydides.core.requirements.PackageRequirementsTagProvider - To generate correct requirements coverage reports you need to set the 'serenity.test.root' property to the package representing the top of your requirements hierarchy." -echo "02:12:04.161 [pool-3-thread-1] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Reading requirements from net.thucydides.core.requirements.PackageRequirementsTagProvider@597228b7" -echo "02:12:04.161 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Reading requirements from net.thucydides.core.requirements.PackageRequirementsTagProvider@597228b7" -echo "02:12:04.161 [pool-3-thread-1] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Reading requirements from net.thucydides.core.requirements.FileSystemRequirementsTagProvider@ed2f160" -echo "02:12:04.161 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Reading requirements from net.thucydides.core.requirements.FileSystemRequirementsTagProvider@ed2f160" -echo "02:12:04.161 [pool-3-thread-1] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Requirements found:[]" -echo "02:12:04.161 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Requirements found:[]" -echo "02:12:04.176 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Requirements found:[]" -echo "02:12:04.178 [pool-3-thread-5] DEBUG net.thucydides.core.requirements.RequirementsTagProvider - Loaded Releases: []" -echo "02:12:04.230 [pool-3-thread-1] DEBUG net.thucydides.core.reports.html.ReportingTask - Aggregate reports generated in 327 ms" -echo "02:12:04.230 [main] DEBUG net.thucydides.core.reports.html.HtmlAggregateStoryReporter - Test outcome reports generated in 327 ms" -echo "02:12:04.769 [main] DEBUG net.serenitybdd.plugins.jira.JiraUpdater - JIRA LISTENER STATUS" -echo "02:12:04.770 [main] DEBUG net.serenitybdd.plugins.jira.JiraUpdater - JIRA URL: null" -echo "02:12:04.770 [main] DEBUG net.serenitybdd.plugins.jira.JiraUpdater - REPORT URL:" -echo "02:12:04.770 [main] DEBUG net.serenitybdd.plugins.jira.JiraUpdater - WORKFLOW ACTIVE: false" -echo "02:12:04.770 [main] INFO net.serenitybdd.plugins.jira.JiraFileServiceUpdater - Update Jira for test results from /Users/jan/example/target/site/serenity" -echo "Report generation done" \ No newline at end of file diff --git a/packages/serenity-js/spec/api/serenity-protractor/framework/protractor_reporter.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/framework/protractor_reporter.spec.ts deleted file mode 100644 index ea88de7067a..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/framework/protractor_reporter.spec.ts +++ /dev/null @@ -1,333 +0,0 @@ -import { - ActivityFinished, - ActivityStarts, - DomainEvent, - Outcome, - RecordedActivity, - RecordedScene, - Result, - SceneFinished, - SceneStarts, -} from '@serenity-js/core/lib/domain'; -import { RehearsalReport } from '@serenity-js/core/lib/reporting'; -import { Journal, Stage, StageManager } from '@serenity-js/core/lib/stage'; -import sinon = require('sinon'); -import expect = require('../../../expect'); -import { given } from 'mocha-testdata'; -import { Runner } from 'protractor/built/runner'; - -import { ProtractorReporter } from '../../../../src/serenity-protractor/reporting'; -import { ProtractorReportExporter } from '../../../../src/serenity-protractor/reporting/protractor_reporter'; - -describe('serenity-protractor', () => { - - describe('framework', () => { - - describe('ProtractorReporter', () => { - - const now = 1485229959000, - feature = 'Managing Shopping Basket', - scenario_1 = 'Adding a product to the basket affects the total price', - scenario_2 = 'Removing a product from the basket affects the total price', - featureFile = 'basket_management/pricing.feature', - - scene_1 = new RecordedScene( - scenario_1, - feature, - { path: featureFile }, - ), - scene_1_duration = 10, - scene_2 = new RecordedScene( - scenario_2, - feature, - { path: featureFile }, - ), - scene_2_duration = 7, - logsIn = new RecordedActivity('Logs in'), - logsIn_duration = 10, - entersUsername = new RecordedActivity('Enters username'), - entersUsername_duration = 6, - entersPassword = new RecordedActivity('Enters password'), - entersPassword_duration = 4, - selectsAProduct = new RecordedActivity('Selects a product'); - - const examplesOfSuccess = [ Result.SUCCESS, Result.PENDING, Result.IGNORED, Result.SKIPPED ], - examplesOfFailure = [ Result.FAILURE, Result.COMPROMISED, Result.ERROR ]; - - let protractor: Runner, - reporter: ProtractorReporter, - stage: Stage; - - beforeEach(() => { - stage = new Stage(new StageManager(new Journal())); - protractor = sinon.createStubInstance(Runner) as any; - - reporter = new ProtractorReporter(protractor); - reporter.assignTo(stage); - }); - - describe('complies with the Protractor Framework specification:', () => { - - // Protractor Framework spec: - // - https://github.com/angular/protractor/blob/master/lib/frameworks/README.md - - describe('notifies Protractor as soon as a test', () => { - - given(...examplesOfSuccess).it('passes', result => { - reporter.notifyOf(new SceneStarts(scene_1, now)); - reporter.notifyOf(new SceneFinished(new Outcome(scene_1, result), now + scene_1_duration)); - - expect(protractor.emit, `scenario finished with ${ Result[ result ] }`). - to.have.been.calledWith('testPass', { - category: feature, - name: scenario_1, - durationMillis: scene_1_duration, - }); - }); - - given(...examplesOfFailure).it('fails', result => { - reporter.notifyOf(new SceneStarts(scene_1, now)); - reporter.notifyOf(new SceneFinished(new Outcome(scene_1, result), now + scene_1_duration)); - - expect(protractor.emit, `scenario finished with ${ Result[ result ] }`). - to.have.been.calledWith('testFail', { - category: feature, - name: scenario_1, - durationMillis: scene_1_duration, - }); - }); - }); - - describe('provides Protractor with a test results object which', () => { - - describe('specifies the correct number of failures when a test suite', () => { - - given(...examplesOfSuccess).it ('succeeds', result => { - reporter.notifyOf(new SceneStarts(scene_1)); - reporter.notifyOf(new SceneFinished(new Outcome(scene_1, result))); - - expect(reporter.finalResults(), `scenario finished with ${ Result[ result ] }`). - to.eventually.have.property('failedCount', 0); - }); - - given(...examplesOfFailure).it ('fails because of one scenario failure', result => { - reporter.notifyOf(new SceneStarts(scene_1)); - reporter.notifyOf(new SceneFinished(new Outcome(scene_1, result))); - - expect(reporter.finalResults(), `scenario finished with ${ Result[ result ] }`). - to.eventually.have.property('failedCount', 1); - }); - - it ('fails because of failures in several scenarios', () => { - examplesOfFailure.forEach(result => { - reporter.notifyOf(new SceneStarts(scene_1)); - reporter.notifyOf(new SceneFinished(new Outcome(scene_1, result))); - }); - - expect(reporter.finalResults()). - to.eventually.have.property('failedCount', examplesOfFailure.length); - }); - }); - - describe('specifies the results for each scene, where', () => { - - describe('one scene', () => { - - given(...examplesOfSuccess).it('passed', result => { - - const report = RehearsalReport.from([ - new SceneStarts(scene_1, now), - new SceneFinished(new Outcome(scene_1, result), now + scene_1_duration), - ]); - - return expect(report.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 0, - specResults: [ - { - description: scene_1.name, - assertions: [], - duration: scene_1_duration, - }, - ], - }); - }); - - given(...examplesOfFailure).it ('failed', result => { - const report = RehearsalReport.from([ - new SceneStarts(scene_1, now), - new SceneFinished(new Outcome(scene_1, result), now + scene_1_duration), - ]); - - return expect(report.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 1, - specResults: [ - { - description: scene_1.name, - assertions: [], - duration: scene_1_duration, - }, - ], - }); - }); - - describe('out of several', () => { - given(...examplesOfFailure).it ('failed', result => { - const report = RehearsalReport.from([ - new SceneStarts(scene_1, now), - new SceneFinished(new Outcome(scene_1, Result.SUCCESS), now + scene_1_duration), - new SceneStarts(scene_2, now + scene_1_duration), - new SceneFinished(new Outcome(scene_2, result), now + scene_1_duration + scene_2_duration), - ]); - - return expect(report.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 1, - specResults: [ - { - description: scene_1.name, - assertions: [], - duration: scene_1_duration, - }, - { - description: scene_2.name, - assertions: [], - duration: scene_2_duration, - }, - ], - }); - }); - }); - }); - }); - - describe('specifies the results for each activity, where', () => { - - const error = new Error('Session timed out'); - error.stack = 'the stacktrace'; - - describe('an activity', () => { - - given(...examplesOfSuccess).it('passed', result => { - const report = RehearsalReport.from([ - new SceneStarts(scene_1, now), - new ActivityStarts(logsIn, now), - new ActivityFinished(new Outcome(logsIn, result), now + logsIn_duration), - new SceneFinished(new Outcome(scene_1, result), now + scene_1_duration), - ]); - - return expect(report.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 0, - specResults: [ - { - description: scene_1.name, - assertions: [ { - passed: true, - errorMsg: undefined, - stackTrace: undefined, - }], - duration: scene_1_duration, - }, - ], - }); - }); - - given(...examplesOfFailure).it('failed', result => { - const report = RehearsalReport.from([ - new SceneStarts(scene_1, now), - new ActivityStarts(logsIn, now), - new ActivityFinished(new Outcome(logsIn, result, error), now + logsIn_duration), - new SceneFinished(new Outcome(scene_1, result, error), now + scene_1_duration), - ]); - - return expect(report.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 1, - specResults: [ - { - description: scene_1.name, - assertions: [ { - passed: false, - errorMsg: error.message, - stackTrace: error.stack, - }], - duration: scene_1_duration, - }, - ], - }); - }); - }); - - describe('some activities', () => { - given(...examplesOfFailure).it('failed', result => { - const report = RehearsalReport.from([ - new SceneStarts(scene_1, now), - new ActivityStarts(logsIn, now), - new ActivityFinished(new Outcome(logsIn, Result.SUCCESS), now + logsIn_duration), - new ActivityStarts(selectsAProduct, now), - new ActivityFinished(new Outcome(selectsAProduct, result, error), now + logsIn_duration), - new SceneFinished(new Outcome(scene_1, result, error), now + scene_1_duration), - ]); - - return expect(report.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 1, - specResults: [ - { - description: scene_1.name, - assertions: [{ - passed: true, - errorMsg: undefined, - stackTrace: undefined, - }, { - passed: false, - errorMsg: error.message, - stackTrace: error.stack, - }], - duration: scene_1_duration, - }, - ], - }); - }); - }); - }); - - describe('limits the result so that it', () => { - - it('only specifies the results for top-level activities', () => { - const events: Array> = [ - new SceneStarts(scene_1, now), - new ActivityStarts(logsIn, now), - new ActivityStarts(entersUsername, - now), - new ActivityFinished(new Outcome(entersUsername, Result.SUCCESS), - now + entersUsername_duration), - new ActivityStarts(entersPassword, - now + entersUsername_duration), - new ActivityFinished(new Outcome(entersPassword, Result.SUCCESS), - now + entersUsername_duration + entersPassword_duration), - new ActivityFinished(new Outcome(logsIn, Result.SUCCESS), - now + entersUsername_duration + entersPassword_duration), - new SceneFinished(new Outcome(scene_1, Result.SUCCESS), - now + scene_1_duration), - ]; - - const screenplay = RehearsalReport.from(events); - - return expect(screenplay.exportedUsing(new ProtractorReportExporter())).to.eventually.deep.equal({ - failedCount: 0, - specResults: [ - { - description: scene_1.name, - assertions: [ { - passed: true, - errorMsg: undefined, - stackTrace: undefined, - }], - duration: 10, - }, - ], - }); - }); - }); - }); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/framework/serenity_protractor_framework.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/framework/serenity_protractor_framework.spec.ts deleted file mode 100644 index a2135a7e38b..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/framework/serenity_protractor_framework.spec.ts +++ /dev/null @@ -1,107 +0,0 @@ -import { Serenity } from '@serenity-js/core'; -import { ConsoleReporter, SerenityBDDReporter } from '@serenity-js/core/lib/reporting'; -import { Config, ProtractorBrowser } from 'protractor'; -import { Runner } from 'protractor/built/runner'; -import { SinonStub } from 'sinon'; - -import { SerenityProtractorFramework } from '../../../../src/serenity-protractor/framework/serenity_protractor_framework'; -import { StandIns } from '../../../../src/serenity-protractor/framework/stand_ins'; -import { ProtractorNotifier } from '../../../../src/serenity-protractor/reporting/protractor_notifier'; -import { ProtractorReporter } from '../../../../src/serenity-protractor/reporting/protractor_reporter'; -import { Photographer } from '../../../../src/serenity-protractor/stage/photographer'; - -import sinon = require('sinon'); -import expect = require('../../../expect'); -import { ProtractorBrowserDetector } from '../../../../src/serenity-protractor/reporting/protractor_browser_detector'; - -describe('serenity-protractor', () => { - - describe('framework', () => { - - describe('SerenityProtractorFramework', () => { - - const serenity = new Serenity(); - - beforeEach(() => { sinon.spy(serenity, 'configure'); }); - afterEach(() => { (serenity.configure as SinonStub).restore(); }); - - it('can be instantiated with a default crew', () => { - - const framework = new SerenityProtractorFramework(serenity, protractorRunner.withConfiguration({ - serenity: { - dialect: 'mocha', - }, - }), protractorBrowser('chrome')); - - expect(framework).to.be.instanceOf(SerenityProtractorFramework); - expect(serenity.configure).to.have.been.calledWith(sinon.match({ - crew: [ - some(SerenityBDDReporter), - some(Photographer), - // core crew: - some(ProtractorReporter), - some(ProtractorBrowserDetector), - some(StandIns), - some(ProtractorNotifier), - ], - })); - }); - - it('can be instantiated with a custom crew, which overrides the default one (except the "protractor core" crew members)', () => { - - const framework = new SerenityProtractorFramework(serenity, protractorRunner.withConfiguration({ - serenity: { - dialect: 'mocha', - crew: [ - new ConsoleReporter(console.log), - ], - }, - }), protractorBrowser('chrome')); - - expect(framework).to.be.instanceOf(SerenityProtractorFramework); - expect(serenity.configure).to.have.been.calledWith(sinon.match({ - crew: [ - some(ConsoleReporter), - // core crew: - some(ProtractorReporter), - some(ProtractorBrowserDetector), - some(StandIns), - some(ProtractorNotifier), - ], - })); - }); - - it('advises the developer what to do if the dialect could not be detected automatically', () => { - expect(() => { - const framework = new SerenityProtractorFramework(serenity, protractorRunner.withConfiguration({}), protractorBrowser('chrome')); - }).to.throw([ - 'Serenity/JS could not determine the test dialect you wish to use. ', - 'Please add `serenity: { dialect: \'...\' }` to your Protractor configuration ', - 'file and choose one of the following options: cucumber, mocha.', - ].join('')); - }); - }); - - const protractorRunner = { - withConfiguration: (config: Config) => { - const r: Runner = sinon.createStubInstance(Runner); - - (r.getConfig as SinonStub).returns(config); - - return r; - }, - }; - - const protractorBrowser = (browserName: string) => { - const browser = { - getCapabilities: () => Promise.resolve({ - get: (capability: string) => browserName, - }), - }; - - return browser as any; - }; - - const some = sinon.match.instanceOf; - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/framework/test_framework_detector.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/framework/test_framework_detector.spec.ts deleted file mode 100644 index 29c5903bd5f..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/framework/test_framework_detector.spec.ts +++ /dev/null @@ -1,128 +0,0 @@ -import sinon = require('sinon'); -import expect = require('../../../expect'); -import { CucumberTestFramework } from '../../../../src/serenity-cucumber/cucumber_test_framework'; -import { MochaTestFramework } from '../../../../src/serenity-mocha/mocha_test_framework'; -import { TestFrameworkDetector } from '../../../../src/serenity-protractor/framework/test_framework_detector'; - -describe('serenity-protractor', () => { - - describe('framework', () => { - - describe('TestFrameworkDetector', () => { - - const detect = new TestFrameworkDetector(); - - describe('Correctly instantiates the required framework', () => { - - describe('when the preferred `dialect`', () => { - - it('is set to `cucumber`', () => { - const framework = detect.frameworkFor({ - serenity: { - dialect: 'cucumber', - }, - - configDir: '/path/to/protractor/configuration', - }); - - expect(framework).to.be.an.instanceOf(CucumberTestFramework); - }); - - it('is set to `mocha`', () => { - const framework = detect.frameworkFor({ - serenity: { - dialect: 'mocha', - }, - - configDir: '/path/to/protractor/configuration', - }); - - expect(framework).to.be.an.instanceOf(MochaTestFramework); - }); - }); - - describe('when the `dialect` is not set, but the config', () => { - - it('seems like `cucumber` because of the `cucumberOpts`', () => { - const framework = detect.frameworkFor({ - cucumberOpts: { - require: [ 'features/**/*.ts' ], - format: 'pretty', - }, - - configDir: '/path/to/protractor/configuration', - }); - - expect(framework).to.be.an.instanceOf(CucumberTestFramework); - }); - - it('seems like `cucumber` because of the `cucumberOpts` defined in capabilities', () => { - const framework = detect.frameworkFor({ - capabilities: { - cucumberOpts: { - require: [ 'features/**/*.ts' ], - format: 'pretty', - }, - }, - - configDir: '/path/to/protractor/configuration', - }); - - expect(framework).to.be.an.instanceOf(CucumberTestFramework); - }); - - it('seems like `mocha` because of the `mochaOpts`', () => { - const framework = detect.frameworkFor({ - mochaOpts: { - ui: 'bdd', - }, - }); - - expect(framework).to.be.an.instanceOf(MochaTestFramework); - }); - - it('seems like `mocha` because of the `mochaOpts` defined in capabilities', () => { - const framework = detect.frameworkFor({ - capabilities: { - mochaOpts: { - ui: 'bdd', - }, - }, - }); - - expect(framework).to.be.an.instanceOf(MochaTestFramework); - }); - - }); - }); - - describe('When the framework could not be detected', () => { - - it('advises how it can be fixed', () => { - expect(() => detect.frameworkFor({ - // no relevant config - })).to.throw( - 'Serenity/JS could not determine the test dialect you wish to use. ' + - 'Please add `serenity: { dialect: \'...\' }` to your Protractor configuration file ' + - 'and choose one of the following options: cucumber, mocha.', - ); - }); - }); - - describe('When the framework is not (yet) supported', () => { - - it('advises how to contact the Serenity/JS team', () => { - expect(() => detect.frameworkFor({ - serenity: { - dialect: 'something-new', - }, - } as any)).to.throw( - 'Serenity/JS does not (yet) support the \'something-new\' test framework. ' + - 'Please let us know on github if you\'d like to see it added!', - ); - }); - }); - }); - - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/keys.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/keys.spec.ts deleted file mode 100644 index 82958f5e8ae..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/keys.spec.ts +++ /dev/null @@ -1,19 +0,0 @@ -import expect = require('../../expect'); - -import * as webdriver from 'selenium-webdriver'; - -import { keyNameOf } from '../../../src/serenity-protractor/keys'; - -describe('Protractor', () => { - - describe ('keyNameOf', () => { - - it ('should determine the name of the key pressed', () => { - expect(keyNameOf(webdriver.Key.ENTER)).to.equal('ENTER'); - }); - - it ('should return the name of the searched for key, if it could not be found', () => { - expect(keyNameOf('unknown-key')).to.equal('unknown-key'); - }); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/click.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/click.spec.ts deleted file mode 100644 index 0ece723576b..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/click.spec.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { Actor } from '@serenity-js/core/lib/screenplay'; -import * as webdriver from 'selenium-webdriver'; - -import sinon = require('sinon'); -import expect = require('../../../../expect'); - -import { BrowseTheWeb, Click, Target } from '../../../../../src/serenity-protractor/screenplay'; -import { fakeBrowserLocating } from './fake_browser'; - -describe('Interactions', () => { - - describe('Click', () => { - const byLocator = webdriver.By.css('button#sign-up'), - target = Target.the('"Sign Up" button').located(byLocator); - - it ('triggers a click event on an element identified by the Target', () => { - const - element = sinon.createStubInstance(webdriver.WebElement) as any, - actor = Actor.named('James').whoCan(BrowseTheWeb.using(fakeBrowserLocating(element))); - - element.click.returns(Promise.resolve()); - - const promise = Click.on(target).performAs(actor); - - return expect(promise).to.be.eventually.fulfilled.then(() => { - expect(element.click).to.have.been.calledOnce; - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/enter.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/enter.spec.ts deleted file mode 100644 index d413caa7ae5..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/enter.spec.ts +++ /dev/null @@ -1,41 +0,0 @@ -import { Actor } from '@serenity-js/core/lib/screenplay'; -import * as webdriver from 'selenium-webdriver'; - -import sinon = require('sinon'); -import expect = require('../../../../expect'); - -import { BrowseTheWeb, Enter, Target } from '../../../../../src/serenity-protractor/screenplay'; -import { fakeBrowserLocating } from './fake_browser'; - -describe('Interactions', () => { - - describe('Enter', () => { - const byLocator = webdriver.By.css('input#username'), - target = Target.the('"Username" field').located(byLocator); - - it ('triggers a sendKeys event on an element identified by the Target', () => { - const - element = sinon.createStubInstance(webdriver.WebElement) as any, - actor = Actor.named('James').whoCan(BrowseTheWeb.using(fakeBrowserLocating(element))), - - promise = Enter.theValue('Jan').into(target).performAs(actor); - - return expect(promise).to.be.eventually.fulfilled.then(() => { - expect(element.sendKeys).to.have.been.calledWith('Jan'); - }); - }); - - it ('allows an additional keystroke to be sent into the Target', () => { - const - element = sinon.createStubInstance(webdriver.WebElement) as any, - actor = Actor.named('James').whoCan(BrowseTheWeb.using(fakeBrowserLocating(element))), - - promise = Enter.theValue('Jan').into(target).thenHit(webdriver.Key.ENTER).performAs(actor); - - return expect(promise).to.be.eventually.fulfilled.then(() => { - expect(element.sendKeys).to.have.been.calledWith('Jan'); - expect(element.sendKeys).to.have.been.calledWith(webdriver.Key.ENTER); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/fake_browser.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/fake_browser.ts deleted file mode 100644 index ee98fecd833..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/fake_browser.ts +++ /dev/null @@ -1,5 +0,0 @@ -import * as webdriver from 'selenium-webdriver'; - -export function fakeBrowserLocating(element: webdriver.WebElement): any { - return { element: _ => element }; -} diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/open.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/open.spec.ts deleted file mode 100644 index ad04b6565d2..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/open.spec.ts +++ /dev/null @@ -1,28 +0,0 @@ -import { Actor } from '@serenity-js/core/lib/screenplay'; -import { ProtractorBrowser } from 'protractor'; - -import sinon = require('sinon'); -import expect = require('../../../../expect'); - -import { BrowseTheWeb, Open } from '../../../../../src/serenity-protractor/screenplay'; - -describe('Interactions', () => { - - describe('Open', () => { - it ('opens a website specified by the url', () => { - const - browser: ProtractorBrowser = sinon.createStubInstance(ProtractorBrowser) as any, - actor = Actor.named('James').whoCan(BrowseTheWeb.using(browser)); - - const url = '/home/index.html'; - - (browser.get as any).withArgs(url).returns(Promise.resolve()); - - const promise = Open.browserOn(url).performAs(actor); - - return expect(promise).to.be.eventually.fulfilled.then(() => { - expect(browser.get).to.have.been.calledWith(url); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/resize_browser_window.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/resize_browser_window.spec.ts deleted file mode 100644 index b21586f7fc9..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/resize_browser_window.spec.ts +++ /dev/null @@ -1,54 +0,0 @@ -import { Actor } from '@serenity-js/core/lib/screenplay'; -import { ProtractorBrowser } from 'protractor'; -import { WebDriver } from 'selenium-webdriver'; - -import sinon = require('sinon'); -import expect = require('../../../../expect'); - -import { BrowseTheWeb, ResizeBrowserWindow } from '../../../../../src/serenity-protractor/screenplay'; - -describe('Interactions', () => { - - describe('ResizeBrowserWindow', () => { - it ('can maximise the browser window', () => { - - const - maximize = sinon.stub().returns(Promise.resolve()), - browser = fakeBrowser({ maximize }), - actor = Actor.named('James').whoCan(BrowseTheWeb.using(browser)), - - promise = ResizeBrowserWindow.toMaximum().performAs(actor); - - return expect(promise).to.be.eventually.fulfilled.then(() => { - expect(maximize).to.have.been.calledOnce; - }); - }); - - it ('can set the window size to an arbitrary width and height', () => { - - const - setSize = sinon.stub().returns(Promise.resolve()), - browser = fakeBrowser({ setSize }), - actor = Actor.named('James').whoCan(BrowseTheWeb.using(browser)), - - promise = ResizeBrowserWindow.to(1024, 768).performAs(actor); - - return expect(promise).to.be.eventually.fulfilled.then(() => { - expect(setSize).to.have.been.calledWithExactly(1024, 768); - }); - }); - - function fakeBrowser(windowOptions): ProtractorBrowser { - const - browser: ProtractorBrowser = sinon.createStubInstance(ProtractorBrowser) as any, - driver: any = sinon.createStubInstance(WebDriver) as any, - window = () => windowOptions; - - driver.manage = (): any => ({ window }); - - browser.driver = driver; - - return browser; - } - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/see.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/see.spec.ts deleted file mode 100644 index 07df96e6ec1..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/interactions/see.spec.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { Actor, Question, See, UsesAbilities } from '@serenity-js/core/lib/screenplay'; -import { AssertionError } from 'chai'; - -import expect = require('../../../../expect'); - -describe('Tasks', () => { - - describe('See', () => { - - class SomeResult implements Question> { - answeredBy(actor: UsesAbilities): PromiseLike { - return Promise.resolve('some value'); - } - } - - it ('allows actor to verify a condition', () => { - const actor = Actor.named('James'); - - const promise = See. - if(new SomeResult(), r => expect(r).to.eventually.equal('some value')). - performAs(actor); - - return expect(promise).to.be.eventually.fulfilled; - }); - - it ('rejects the promise if the condition is not met', () => { - const actor = Actor.named('James'); - - const promise = See. - if(new SomeResult(), r => expect(r).to.eventually.equal('other value')). - performAs(actor); - - return expect(promise).to.be.eventually.rejectedWith(AssertionError, 'expected \'some value\' to equal \'other value\''); - }); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/screenplay/ui/target.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/screenplay/ui/target.spec.ts deleted file mode 100644 index 85beec4562a..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/screenplay/ui/target.spec.ts +++ /dev/null @@ -1,106 +0,0 @@ -import * as webdriver from 'selenium-webdriver'; - -import sinon = require('sinon'); -import expect = require('../../../../expect'); - -import { Target } from '../../../../../src/screenplay-protractor'; - -describe ('Target', () => { - - const byLocator = webdriver.By.css('button#sign-up'); - - it ('represents a named locator', () => { - - const target = Target.the('"Sign Up" button').located(byLocator); - - expect(target.toString()).to.equal('the "Sign Up" button'); - }); - - it ('can be resolved using protractor `element` resolver', () => { - const - element = sinon.spy(), - target = Target.the('"Sign Up" button').located(byLocator); - - target.resolveUsing(element); - - expect(element).to.have.been.calledWith(byLocator); - }); - - it ('can have its name changed at a later stage', () => { - const target = Target.the('Nav button').located(byLocator); - - expect(target.called('"Sign Up" button').toString()).to.equal('the "Sign Up" button'); - }); - - it ('can have its name resolved at a later stage', () => { - const target = Target.the('"{0}" button').located(byLocator); - - expect(target.of('Sign Up').toString()).to.equal('the "Sign Up" button'); - }); - - it ('can have a CSS locator defined using tokens to be resolved at a later stage', () => { - const - byLocatorTemplate = webdriver.By.css('{0}#sign-up.{1}'), - element = sinon.spy(), - target = Target.the('"Sign Up" button').located(byLocatorTemplate); - - target.of('button', 'active').resolveUsing(element); - - expect(element).to.have.been.calledWith(webdriver.By.css('button#sign-up.active')); - }); - - it ('can have an ID locator defined using tokens to be resolved at a later stage', () => { - const - byLocatorTemplate = webdriver.By.id('sign-up-{0}'), - element = sinon.spy(), - target = Target.the('"Sign Up" button').located(byLocatorTemplate); - - target.of('button').resolveUsing(element); - - expect(element).to.have.been.calledWith(webdriver.By.id('sign-up-button')); - }); - - it ('can have an XPath locator defined using numeric tokens to be resolved at a later stage', () => { - const - byLocatorTemplate = webdriver.By.xpath(`//ul[@id='items']//li[{0}]`), - element = sinon.spy(), - target = Target.the('n-th item').located(byLocatorTemplate); - - target.of(3).resolveUsing(element); - - expect(element).to.have.been.calledWith(webdriver.By.xpath(`//ul[@id='items']//li[3]`)); - }); - - it ('correctly overrides the toString method of the cloned locator', () => { - const - byLocatorTemplate = webdriver.By.id('sign-up-{0}'), - target = Target.the('"Sign Up" button').located(byLocatorTemplate), - - result = (target.of('button') as any).locator.toString(); - - expect(result).to.equal('By(css selector, *[id="sign-up-button"])'); - }); - - it ('can describe a locator matching multiple elements', () => { - const - byGroupLocator = webdriver.By.css('ul>li'), - element = { all: sinon.spy() }, - target = Target.the('items').located(byGroupLocator); - - target.resolveAllUsing(element); - - expect(element.all).to.have.been.calledWith(webdriver.By.css('ul>li')); - }); - - it ('complains if it cannot replace the tokens defined in the locator (Protractor issue #3508)', () => { - const - byModelTemplate: any = { - toString: () => 'by.model("checkbox")', - }, - target = Target.the('checkbox').located(byModelTemplate); - - expect(() => { - target.of('some-replacement'); - }).to.throw('by.model("checkbox") is not a webdriver-compatible locator so you won\'t be able to use token replacement with it'); - }); -}); diff --git a/packages/serenity-js/spec/api/serenity-protractor/stage/photographer.spec.ts b/packages/serenity-js/spec/api/serenity-protractor/stage/photographer.spec.ts deleted file mode 100644 index 91220165d3f..00000000000 --- a/packages/serenity-js/spec/api/serenity-protractor/stage/photographer.spec.ts +++ /dev/null @@ -1,357 +0,0 @@ -import { - ActivityFinished, - ActivityStarts, - Outcome, - Photo, - PhotoAttempted, - PhotoReceipt, - RecordedActivity, - RecordedScene, - Result, - SceneFinished, - SceneStarts, -} from '@serenity-js/core/lib/domain'; -import { FileSystem } from '@serenity-js/core/lib/io'; -import { Cast, Journal, Stage, StageManager } from '@serenity-js/core/lib/stage'; - -import sinon = require('sinon'); -import expect = require('../../../expect'); - -import { Actor, BrowseTheWeb } from '../../../../src/screenplay-protractor'; - -import { - ActivityOfInterest, - Md5HashedPictureNames, - Photographer, - photographer, - PictureNamingStrategy, -} from '../../../../src/serenity-protractor/stage/photographer'; - -import { TakeAPhoto, TimingBehaviour } from '../../../../src/serenity-protractor/stage/photographer-timing'; - -describe('Photographer', () => { - - const image = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/TQBcNTh/AAAAAXRSTlPM0jRW/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=', - imageBuffer = new Buffer(image, 'base64'); - - describe('with default configuration', () => { - - let thePhotographer: Photographer, - stageManager: StageManager, - stage: Stage, - fileSystem: any; - - const - activity = new RecordedActivity('Adds an item to the basket'), - photoName = 'photo.png', - photoPath = 'target/serenity/site/' + photoName, - now = 1469028588000; - - beforeEach( () => { - fileSystem = sinon.createStubInstance(FileSystem) as any; - - stageManager = new StageManager(new Journal()); - stage = new Stage(stageManager); - - thePhotographer = new Photographer( - new ActivityOfInterest(Result.Finished), - new TimingBehaviour(new TakeAPhoto(), new TakeAPhoto()), - fileSystem, - new CallsEveryPhotoTheSame(photoName), - ); - }); - - class Actors implements Cast { - actor(name: string): Actor { - switch (name) { - case 'Basil': return Actor.named(name).whoCan(BrowseTheWeb.using(fawltyBrowserThrowing(invalidSessionError))); - case 'Manuel': return Actor.named(name).whoCan(BrowseTheWeb.using(fawltyBrowserThrowing(unknownError))); - default: return Actor.named(name).whoCan(BrowseTheWeb.using(fakeBrowserShowing(image))); - } - } - } - - describe('When the show has started and there is an Actor in the spotlight', () => { - - beforeEach(() => { - thePhotographer.assignTo(stage); - - stage.enter(new Actors()); - stage.theActorCalled('Sybil'); - }); - - describe('When the Actor in the spotlight starts to perform an Activity', () => { - - it('Attempts to take a photo of what the Actor sees in their Browser', () => { - - thePhotographer.notifyOf(new ActivityStarts(activity, now)); - - expect(stageManager.readTheJournal().pop()).to.be.instanceOf(PhotoAttempted); - }); - - it('Issues a Receipt for the Photo, with the same timestamp as the Activity concerned', () => { - - thePhotographer.notifyOf(new ActivityStarts(activity, now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - expect(photoAttempted.timestamp).to.equal(now); - expect(photoAttempted.value).to.be.instanceOf(PhotoReceipt); - expect(photoAttempted.value.activity).to.deep.equal(activity); - }); - - it('Promises to tell the Stage Manager where they can collect the Photo when it\'s ready', () => { - - fileSystem.store.withArgs(photoName, imageBuffer).returns(photoPath); - - thePhotographer.notifyOf(new ActivityStarts(activity, now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - return expect(photoAttempted.value.photo).to.eventually.deep.equal(new Photo(photoPath)); - }); - - it('Ignores any problems related to the Actor\'s browser not being ready to capture a screenshot', () => { - - stage.theActorCalled('Basil'); - - thePhotographer.notifyOf(new ActivityStarts(activity, now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - return expect(photoAttempted.value.photo).to.eventually.be.undefined; - }); - - it('Reports any other problems that might occur', () => { - - stage.theActorCalled('Manuel'); - - thePhotographer.notifyOf(new ActivityStarts(activity, now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - return expect(photoAttempted.value.photo).to.eventually.be.rejectedWith(unknownError); - }); - - it('Notifies the Stage Manager of any work in progress', () => { - - fileSystem.store.withArgs(photoName, imageBuffer).returns(photoPath); - - thePhotographer.notifyOf(new ActivityStarts(activity, now)); - - return expect(stageManager.waitForNextCue()).to.eventually.be.fulfilled.then(tasks => { - expect(tasks).to.have.length(1); - expect(tasks.pop()).to.be.instanceOf(Photo); - }); - }); - }); - - describe('When the Actor in the spotlight finished to perform an Activity', () => { - - describe('Attempts to take a photo of what the Actor sees in their Browser when the execution of their Activity:', () => { - - it('finished with a Success', () => { - - fileSystem.store.withArgs(photoName, imageBuffer).returns(photoPath); - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.SUCCESS), now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - expect(photoAttempted).to.be.instanceOf(PhotoAttempted); - expect(photoAttempted.timestamp).to.equal(now); - - expect(photoAttempted.value).to.be.instanceOf(PhotoReceipt); - expect(photoAttempted.value.activity).to.deep.equal(activity); - return expect(photoAttempted.value.photo).to.eventually.deep.equal(new Photo(photoPath)); - }); - - it('finished with a Failure', () => { - - const failure = new Error('Expected the list of items to contain 5 items but it only had 4'); - - fileSystem.store.withArgs(photoName, imageBuffer).returns(photoPath); - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.FAILURE, failure), now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - expect(photoAttempted).to.be.instanceOf(PhotoAttempted); - expect(photoAttempted.timestamp).to.equal(now); - - expect(photoAttempted.value).to.be.instanceOf(PhotoReceipt); - expect(photoAttempted.value.activity).to.deep.equal(activity); - return expect(photoAttempted.value.photo).to.eventually.deep.equal(new Photo(photoPath)); - }); - - it('finished with an Error', () => { - - const error = new Error('The element was not found'); - - fileSystem.store.withArgs(photoName, imageBuffer).returns(photoPath); - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.ERROR, error), now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - expect(photoAttempted).to.be.instanceOf(PhotoAttempted); - expect(photoAttempted.timestamp).to.equal(now); - - expect(photoAttempted.value).to.be.instanceOf(PhotoReceipt); - expect(photoAttempted.value.activity).to.deep.equal(activity); - return expect(photoAttempted.value.photo).to.eventually.deep.equal(new Photo(photoPath)); - }); - - it('was Compromised (by problems with 3rd party systems for example)', () => { - - const error = new Error('Client database is offline'); - - fileSystem.store.withArgs(photoName, imageBuffer).returns(photoPath); - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.COMPROMISED, error), now)); - - const photoAttempted = stageManager.readTheJournal().pop(); - - expect(photoAttempted).to.be.instanceOf(PhotoAttempted); - expect(photoAttempted.timestamp).to.equal(now); - - expect(photoAttempted.value).to.be.instanceOf(PhotoReceipt); - expect(photoAttempted.value.activity).to.deep.equal(activity); - return expect(photoAttempted.value.photo).to.eventually.deep.equal(new Photo(photoPath)); - }); - }); - - describe('Does not attempt to take photos of Activity that has never been performed because:', () => { - - it('was Skipped', () => { - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.SKIPPED), now)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - - it('was Ignored', () => { - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.IGNORED), now)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - - it('is Pending', () => { - - thePhotographer.notifyOf(new ActivityFinished(new Outcome(activity, Result.PENDING), now)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - }); - }); - - it('is not interested in events other that the Start and Finish of an Activity', () => { - - const scene = new RecordedScene('A user adds a product to their basket', 'Checkout'); - - thePhotographer.notifyOf(new SceneStarts(scene, now)); - thePhotographer.notifyOf(new SceneFinished(new Outcome(scene, Result.SUCCESS), now)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - }); - - describe('When the show has not started', () => { - - it('Won\'t take a photo if there\'s no Cast on the Stage', () => { - thePhotographer.assignTo(stage); - - thePhotographer.notifyOf(new ActivityStarts(activity)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - - it('Won\'t take a photo unless there\'s an Actor in the spotlight', () => { - thePhotographer.assignTo(stage); - - stage.enter(new Actors()); - - thePhotographer.notifyOf(new ActivityStarts(activity)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - }); - - describe('When there is nothing of interest', () => { - - it('Won\'t take a photo if the events it\'s notified of are not of interest', () => { - thePhotographer.assignTo(stage); - - thePhotographer.notifyOf(new ActivityStarts(activity)); - - expect(stageManager.readTheJournal()).to.be.empty; - }); - }); - - const invalidSessionError = new Error( - 'This driver instance does not have a valid session ID ' + - '(did you call WebDriver.quit()?) and may no longer be used.'), - unknownError = new Error('Something\'s probably gone wrong ¯\\_(ツ)_/¯'); - - function fakeBrowserShowing(picture: string) { - return { takeScreenshot: ( () => Promise.resolve(picture) ) } as any; - } - - function fawltyBrowserThrowing(error: Error) { - return { takeScreenshot: ( () => { throw error; })} as any; - } - - class CallsEveryPhotoTheSame implements PictureNamingStrategy { - - constructor(private filename: string) { - } - - nameFor(base64encodedData: string): string { - return this.filename; - } - } - }); - - describe('PictureNamingStrategy', () => { - - describe('Md5HashedPictureNames', () => { - - it('gives a photo a name based on an MD5 hash of its contents', () => { - - const names = new Md5HashedPictureNames(); - - expect(names.nameFor(image)).to.equal('e06827c6a8d3b787d15170da9e0aeeba'); - }); - - it('appends a file extension if required', () => { - - const names = new Md5HashedPictureNames('png'); - - expect(names.nameFor(image)).to.equal('e06827c6a8d3b787d15170da9e0aeeba.png'); - }); - }); - }); - - describe('Easy instantiation', () => { - - describe('When assigning stage crew members in the protractor conf file', () => { - - it('can be instantiated using sensible defaults', () => { - expect(photographer()).to.be.instanceOf(Photographer); - }); - - it('allows for the time of taking the screenshot to be overridden', () => { - expect(Photographer.who(_ => _.takesPhotosOf(_.Failures))).to.be.instanceOf(Photographer); - }); - - it('allows for the time of taking the screenshot to be overridden', () => { - expect(Photographer.who(_ => _.takesPhotosWhen(_.Activity_Finishes))).to.be.instanceOf(Photographer); - }); - - it('allows for path to the reports to be overridden', () => { - expect(Photographer.who(_ => _.storesPhotosAt('/tmp/reports'))).to.be.instanceOf(Photographer); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/cookbook/alerts.recipe.ts b/packages/serenity-js/spec/cookbook/alerts.recipe.ts deleted file mode 100644 index 02069ebbc70..00000000000 --- a/packages/serenity-js/spec/cookbook/alerts.recipe.ts +++ /dev/null @@ -1,61 +0,0 @@ -import expect = require('../expect'); - -import { by, protractor } from 'protractor'; - -import { - Actor, - BrowseTheWeb, - Clear, - Click, - Open, - See, - Target, - Text, - UseAngular, - WebElement, -} from '../../src/screenplay-protractor'; - -import { Alert } from '../../src/serenity-protractor/screenplay/interactions/alert'; -import { WaitForAlert } from '../../src/serenity-protractor/screenplay/interactions/waitForAlert'; -import { AppServer } from '../support/server'; - -class AlertTargets { - static Trigger = Target.the('alert trigger').located(by.id('alert-demo-trigger')); - static TextResult = Target.the('text of the alert clicking result').located(by.id('alert-demo-result')); -} - -describe('When demonstrating how to work with alert windows, a test scenario', function() { - - this.timeout(10000); - - const app = new AppServer(); - const nick = Actor.named('Nick').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - after(app.stop()); - - describe('running in a real browser', () => { - - beforeEach(() => - nick.attemptsTo( - UseAngular.disableSynchronisation(), - Open.browserOn(app.demonstrating('alerts')), - ).then(() => expect(nick.toSee(WebElement.of(AlertTargets.Trigger))).displayed)); - - it('can click the OK action of a triggered alert and see the alert accepted', () => - nick.attemptsTo( - Click.on(AlertTargets.Trigger), - WaitForAlert.toBePresent(), - Alert.accept(), - See.if(Text.of(AlertTargets.TextResult), text => expect(text).to.eventually.equal('You pressed OK!')), - )); - - it('can click the cancel action of a triggered alert and see the alert dismissed', () => - nick.attemptsTo( - Click.on(AlertTargets.Trigger), - WaitForAlert.toBePresent(), - Alert.dismiss(), - See.if(Text.of(AlertTargets.TextResult), text => expect(text).to.eventually.equal('You pressed Cancel!')), - )); - }); -}); diff --git a/packages/serenity-js/spec/cookbook/angular_internals.recipe.ts b/packages/serenity-js/spec/cookbook/angular_internals.recipe.ts deleted file mode 100644 index e7537362936..00000000000 --- a/packages/serenity-js/spec/cookbook/angular_internals.recipe.ts +++ /dev/null @@ -1,92 +0,0 @@ -import { by, protractor } from 'protractor'; - -import expect = require('../expect'); -import { Actor, BrowseTheWeb, Evaluate, Execute, Open, Target, Text, Value } from '../../src/screenplay-protractor'; -import { AppServer } from '../support/server'; - -class Username { - static Field = Target.the('username field').located(by.css('[name="text-input"] label[for="text"] input')); - static Result = Target.the('username value').located(by.css('[name="text-input"] label[for="text"] pre')); -} - -class Newsletter { - static Checkbox = Target.the('newsletter checkbox').located(by.css('label[for="checkbox"] input')); - static Result = Target.the('newsletter result').located(by.css('label[for="checkbox"] pre')); -} - -describe ('When working with an Angular app, a test scenario can execute', function() { - - this.timeout(10000); - - const app = new AppServer(); - const james = Actor.named('James').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - before(() => james.attemptsTo(Open.browserOn(app.demonstrating('angular_internals')))); - after(app.stop()); - - describe('a script that', () => { - - it ('runs within its context', () => - james.attemptsTo( - Execute.script('arguments[0].click();').on(Newsletter.Checkbox), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Newsletter.Checkbox))).eventually.equal('on'), - ]))); - - it ('can be called with arguments', () => - james.attemptsTo( - Execute.script('angular.element(arguments[0]).val(arguments[1]).triggerHandler("input");').withArguments(Username.Field, 'Jimmy'), - ).then(() => Promise.all([ - expect(james.toSee(Text.of(Username.Result))).eventually.equal('Jimmy'), - ]))); - }); - - describe('a function that', () => { - - it ('runs within its context', () => - james.attemptsTo( - Execute.fn(function() { arguments[0].click(); }).on(Newsletter.Checkbox), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Newsletter.Checkbox))).eventually.equal('on'), - ]))); - }); - - describe('an asynchronous script that', () => { - - it ('runs within its context', () => - james.attemptsTo( - Execute.asyncScript( - 'var callback = arguments[arguments.length - 1];', - 'arguments[0].click();', - 'callback();', - ).on(Newsletter.Checkbox), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Newsletter.Checkbox))).eventually.equal('on'), - ]))); - - it ('can be called with arguments', () => - james.attemptsTo( - Execute.asyncScript( - 'var callback = arguments[arguments.length - 1];', - 'angular.element(arguments[0]).val(arguments[1]).triggerHandler("input");', - 'callback();', - ).on(Username.Field).withArguments('James'), - ).then(() => Promise.all([ - expect(james.toSee(Text.of(Username.Result))).eventually.equal('James'), - ]))); - }); - - describe('an asynchronous function that', () => { - - it ('runs within its context', () => - james.attemptsTo( - Execute.asyncFn(function(element, callback) { - element.click(); - callback(); - }).on(Newsletter.Checkbox), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Newsletter.Checkbox))).eventually.equal('on'), - ]))); - }); -}); diff --git a/packages/serenity-js/spec/cookbook/apps/alerts.html b/packages/serenity-js/spec/cookbook/apps/alerts.html deleted file mode 100644 index 8af395c03f8..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/alerts.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - -

Test page for alert unit test

- - - -

- - - - - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/angular_internals.html b/packages/serenity-js/spec/cookbook/apps/angular_internals.html deleted file mode 100644 index 2e59d172d55..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/angular_internals.html +++ /dev/null @@ -1,57 +0,0 @@ - - - - Basic Forms - - - - - - - -
- -
- Working with Angular internals - - - - - -
- -
- - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/content.html b/packages/serenity-js/spec/cookbook/apps/content.html deleted file mode 100644 index 2a66a528e20..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/content.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - Serenity/JS Cookbook - - - - - - - - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/html_form.html b/packages/serenity-js/spec/cookbook/apps/html_form.html deleted file mode 100644 index 16122a5d37e..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/html_form.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - Basic Forms - - - - - - - -
- -
- Working with text - - - - - -
- -
- Working with checkboxes - - -
- -
- Working with options - - - - -
- -
- - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/mouse_events.html b/packages/serenity-js/spec/cookbook/apps/mouse_events.html deleted file mode 100644 index 5873b54704f..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/mouse_events.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Mouse events - - - - -
-

{{ title }}

-
- -
- -
- -
- - - - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/popup.html b/packages/serenity-js/spec/cookbook/apps/popup.html deleted file mode 100644 index 4959b5fbb95..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/popup.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - Non-Angular Popup - - -

Yup, it's a pop-up!

- - - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/waiting.html b/packages/serenity-js/spec/cookbook/apps/waiting.html deleted file mode 100644 index 176ca34a78f..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/waiting.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - demo app - - - - -
- - -
- -
- - -
- - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/apps/windows.html b/packages/serenity-js/spec/cookbook/apps/windows.html deleted file mode 100644 index 1f76e829faa..00000000000 --- a/packages/serenity-js/spec/cookbook/apps/windows.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - Popups - - - -
- open a popup -
- - - - - \ No newline at end of file diff --git a/packages/serenity-js/spec/cookbook/content.recipe.ts b/packages/serenity-js/spec/cookbook/content.recipe.ts deleted file mode 100644 index af27ac0eaf7..00000000000 --- a/packages/serenity-js/spec/cookbook/content.recipe.ts +++ /dev/null @@ -1,66 +0,0 @@ -import expect = require('../expect'); - -import { by, protractor } from 'protractor'; - -import { Actor, Attribute, BrowseTheWeb, Target, UseAngular, Website } from '../../src/screenplay-protractor'; -import { Open, Text, WebElement } from '../../src/serenity-protractor'; - -import { AppServer } from '../support/server'; - -/* - * Minimalistic page objects; each one of the below represents a UI widget from the cookbook/apps/basic_forms.html app. - */ - -class Cookbook { - static Main_Heading = Target.the('main heading').located(by.css('h1')); - static Secondary_Heading = Target.the('secondary heading').located(by.css('h2')); - static Article = Target.the('article').located(by.css('article')); - static Table_of_Contents = Target.the('table of contents').located(by.css('article nav ul li')); -} - -describe ('When demonstrating the usage of a HTML page, a test scenario', function() { - - this.timeout(10000); - - const app = new AppServer(); - const james = Actor.named('James').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - before(() => james.attemptsTo( - UseAngular.disableSynchronisation(), // this is a standard, non-angular website; - Open.browserOn(app.demonstrating('content')), // no need for angular-specific synchronisation here - )); - after(app.stop()); - - it ('can read the text of on-screen elements', () => Promise.all([ - expect(james.toSee(Text.of(Cookbook.Main_Heading))) - .eventually.equal('Serenity/JS Cookbook'), - expect(james.toSee(Text.of(Cookbook.Secondary_Heading))) - .eventually.contain('Recipes'), - ])); - - it ('can read the text of all elements matching the target', () => - - expect(james.toSee(Text.ofAll(Cookbook.Table_of_Contents))) - .eventually.deep.include('Working with static websites')); - - it ('can read the title of the website', () => - - expect(james.toSee(Website.title())) - .eventually.equal('Serenity/JS Cookbook')); - - it ('can read the url of the website', () => - - expect(james.toSee(Website.url())) - .eventually.contain('content')); - - it ('can read an attribute of an on-screen element', () => - - expect(james.toSee(Attribute.of(Cookbook.Article).called('class'))) - .eventually.equal('container')); - - it ('can check the visibility of an on-screen element', () => { - - expect(james.toSee(WebElement.of(Cookbook.Article))).displayed; - }); -}); diff --git a/packages/serenity-js/spec/cookbook/html_form.recipe.ts b/packages/serenity-js/spec/cookbook/html_form.recipe.ts deleted file mode 100644 index a6b9f834b8c..00000000000 --- a/packages/serenity-js/spec/cookbook/html_form.recipe.ts +++ /dev/null @@ -1,101 +0,0 @@ -import expect = require('../expect'); -import { Actor, BrowseTheWeb, Target } from '../../src/screenplay-protractor'; -import { Click, Enter, Open, Select, SelectedValue, SelectedValues, Text, Value } from '../../src/serenity-protractor'; - -import { AppServer } from '../support/server'; - -import { by, protractor } from 'protractor'; -import { Execute } from '../../src/serenity-protractor/screenplay/interactions/execute'; - -/// [pageobjects] -class Username { - static Field = Target.the('username field').located(by.css('[name="text-input"] label[for="text"] input')); - static Result = Target.the('username value').located(by.css('[name="text-input"] label[for="text"] pre')); -} - -class Bio { - static Field = Target.the('bio field').located(by.css('[name="text-input"] label[for="textarea"] textarea')); - static Result = Target.the('bio value').located(by.css('[name="text-input"] label[for="textarea"] pre')); -} - -class Newsletter { - static Checkbox = Target.the('newsletter checkbox').located(by.css('[name="checkboxes"] label[for="checkbox"] input')); - static Result = Target.the('newsletter result').located(by.css('[name="checkboxes"] label[for="checkbox"] pre')); -} - -class SingleCountry { - static Selector = Target.the('country selector').located(by.css('[name="options"] label[for="single-option"] select')); - static Result = Target.the('country result').located(by.css('[name="options"] label[for="single-option"] pre')); -} - -class MultiCountry { - static Selector = Target.the('country selector').located(by.css('[name="options"] label[for="multiple-options"] select')); - static Result = Target.the('country result').located(by.css('[name="options"] label[for="multiple-options"] pre')); -} -/// [pageobjects] - -describe ('When demonstrating the usage of an HTML form, a test scenario', function() { - - this.timeout(10000); - - const app = new AppServer(); - const james = Actor.named('James').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - before(() => james.attemptsTo(Open.browserOn(app.demonstrating('html_form')))); - after(app.stop()); - - it ('can interact with a single-line text input', () => - - james.attemptsTo( - Enter.theValue('James').into(Username.Field), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Username.Field))).eventually.equal('James'), - expect(james.toSee(Text.of(Username.Result))).eventually.equal('James'), - ]))); - - it ('can interact with a text area', () => - - james.attemptsTo( - Enter.theValue('Lorem ipsum\ndolor\nsit amet').into(Bio.Field), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Bio.Field))).eventually.equal('Lorem ipsum\ndolor\nsit amet'), - expect(james.toSee(Text.of(Bio.Result))).eventually.equal('Lorem ipsum\ndolor\nsit amet'), - ]))); - - it ('can interact with a checkbox', () => - - james.attemptsTo( - Click.on(Newsletter.Checkbox), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Newsletter.Checkbox))).eventually.equal('on'), - expect(james.toSee(Text.of(Newsletter.Result))).eventually.equal('true'), - ]))); - - it ('can execute script to click a checkbox, as an example for script execution..', () => - james.attemptsTo( - Execute.script('arguments[0].click();').on(Newsletter.Checkbox), - ).then(() => Promise.all([ - expect(james.toSee(Value.of(Newsletter.Checkbox))).eventually.equal('on'), - ]))); - - it ('can interact with a select box', () => - - james.attemptsTo( - Select.theValue('France').from(SingleCountry.Selector), - ).then(() => Promise.all([ - expect(james.toSee(SelectedValue.of(SingleCountry.Selector))).eventually.equal('France'), - expect(james.toSee(Text.of(SingleCountry.Result))).eventually.equal('France'), - ]))); - - describe('when a real browser is available', () => { - - it('can interact with multi-choice select box', () => - james.attemptsTo( - Select.values('Poland', 'France').from(MultiCountry.Selector), - ).then(() => Promise.all([ - expect(james.toSee(SelectedValues.of(MultiCountry.Selector))).eventually.deep.equal([ 'Poland', 'France' ]), - expect(james.toSee(Text.of(MultiCountry.Result))).eventually.equal('Poland, France'), - ]))); - }); -}); diff --git a/packages/serenity-js/spec/cookbook/mouse_events.recipe.ts b/packages/serenity-js/spec/cookbook/mouse_events.recipe.ts deleted file mode 100644 index 62e51aa5003..00000000000 --- a/packages/serenity-js/spec/cookbook/mouse_events.recipe.ts +++ /dev/null @@ -1,39 +0,0 @@ -import expect = require('../expect'); - -import { by, protractor } from 'protractor'; - -import { Actor, BrowseTheWeb, Target } from '../../src/screenplay-protractor'; -import { Click, DoubleClick, Open, Text } from '../../src/serenity-protractor'; - -import { AppServer } from '../support/server'; - -class MouseEvents { - static Event_Trigger = Target.the('event-triggering button').located(by.css('#event-tester-{0} button')); - static Triggered_Result = Target.the('event-triggering button').located(by.css('#event-tester-{0} pre')); -} - -describe ('When demonstrating the usage of a Static Website, a test scenario', function() { - - this.timeout(10000); - - const app = new AppServer(); - const james = Actor.named('James').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - before(() => james.attemptsTo(Open.browserOn(app.demonstrating('mouse_events')))); - after(app.stop()); - - it ('can click the on-screen elements', () => - james.attemptsTo( - Click.on(MouseEvents.Event_Trigger.of('click')), - ).then(() => - expect(james.toSee(Text.of(MouseEvents.Triggered_Result.of('click')))) - .eventually.equal('click works!'))); - - it ('can double-click the on-screen elements', () => - james.attemptsTo( - DoubleClick.on(MouseEvents.Event_Trigger.of('dblclick')), - ).then(() => - expect(james.toSee(Text.of(MouseEvents.Triggered_Result.of('dblclick')))) - .eventually.equal('dblclick works!'))); -}); diff --git a/packages/serenity-js/spec/cookbook/waiting.recipe.ts b/packages/serenity-js/spec/cookbook/waiting.recipe.ts deleted file mode 100644 index cf4b024746d..00000000000 --- a/packages/serenity-js/spec/cookbook/waiting.recipe.ts +++ /dev/null @@ -1,254 +0,0 @@ -import expect = require('../expect'); - -import { by, protractor } from 'protractor'; - -import { - Actor, - BrowseTheWeb, - Clear, - Click, - Duration, - Enter, - Is, - Open, - PerformsTasks, - Select, - Target, - Task, - Wait, - WebElement, -} from '../../src/screenplay-protractor'; - -import { AppServer } from '../support/server'; - -export class Playground { - static Examples = Target.the('example type').located(by.id('example_type')); - static Timeout_Type = Target.the('timeout function type').located(by.id('timeout_type')); - static Timeout_Length = Target.the('timeout length').located(by.id('timeout_length')); - static Trigger = Target.the('trigger button').located(by.css('#timeouts button')); - static Result = Target.the('result').located(by.css('#timeouts #example .result')); -} - -class ChooseAnExample implements Task { - private timeout_length = Duration.ofMillis(500); - private timeout_type = '$timeout' ; - - static whereElementBecomes = (example: string) => new ChooseAnExample(example); - - using = (timeout_type: string) => { - this.timeout_type = timeout_type; - - return this; - } - - after = (length: Duration) => { - this.timeout_length = length; - - return this; - } - - performAs = (actor: PerformsTasks) => actor.attemptsTo( - Select.theValue(this.example).from(Playground.Examples), - Select.theValue(this.timeout_type).from(Playground.Timeout_Type), - Clear.theValueOf(Playground.Timeout_Length), - Enter.theValue(this.timeout_length.toMillis()).into(Playground.Timeout_Length), - Click.on(Playground.Trigger), - ); - - constructor(private example: string) { - } -} - -describe ('When waiting for things to happen, a test scenario', function() { - - this.timeout(10000); - - const Trigger_Delay = Duration.ofMillis(2000), - Not_Long_Enough = Duration.ofMillis(500), - Long_Enough = Duration.ofMillis(4000); - - const - app = new AppServer(), - james = Actor.named('James').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - after(app.stop()); - - beforeEach(() => - - james.attemptsTo( - Open.browserOn(app.demonstrating('waiting')), - ). - - then(() => expect(james.toSee(WebElement.of(Playground.Result))).not.displayed)); - - [ - 'setTimeout', - '$timeout', - '$interval', - ].forEach(timeoutFunction => { - - describe(`using Passive Wait (${ timeoutFunction })`, () => { - - it ('will fail if the timeout is too short', () => - - james.attemptsTo( - ChooseAnExample.whereElementBecomes('Visible').after(Trigger_Delay).using(timeoutFunction), - Wait.for(Not_Long_Enough), - ). - - then(() => expect(james.toSee(WebElement.of(Playground.Result))).not.displayed)); - - it ('will pass if the timeout is long enough', () => - - james.attemptsTo( - ChooseAnExample.whereElementBecomes('Visible').after(Trigger_Delay).using(timeoutFunction), - Wait.for(Long_Enough), - ). - - then(() => expect(james.toSee(WebElement.of(Playground.Result))).displayed)); - }); - - describe(`using Active Wait (${ timeoutFunction })`, () => { - - it('can rely on a default timeout provided by Wait.until(..) to be sensibly long enough', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Visible').after(Trigger_Delay).using(timeoutFunction), - Wait.until(Playground.Result, Is.visible()), - )).to.be.fulfilled); - - describe('to determine if an element is visible', () => { - - it('will fail if the condition is not met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Visible').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Not_Long_Enough).until(Playground.Result, Is.visible()), - )).to.be.rejectedWith('The result did not become visible')); - - it('will pass if the condition is met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Visible').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Long_Enough).until(Playground.Result, Is.visible()), - )).to.be.fulfilled. - - then(() => Promise.all([ - expect(james.toSee(WebElement.of(Playground.Result))).displayed, - expect(james.toSee(WebElement.of(Playground.Result))).present, - ]))); - }); - - describe('to determine if an element is invisible', () => { - - it('will fail if the condition is not met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Invisible').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Not_Long_Enough).until(Playground.Result, Is.invisible()), - )).to.be.rejectedWith('The result did not become invisible')); - - it('will pass if the condition is met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Invisible').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Long_Enough).until(Playground.Result, Is.invisible()), - )).to.be.fulfilled. - - then(() => Promise.all([ - expect(james.toSee(WebElement.of(Playground.Result))).not.displayed, - expect(james.toSee(WebElement.of(Playground.Result))).present, - ]))); - }); - - describe('to determine if an element is present', () => { - - it('will fail if the condition is not met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Present').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Not_Long_Enough).until(Playground.Result, Is.present()), - )).to.be.rejectedWith('The result did not become present')); - - it('will pass if the condition is met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Present').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Long_Enough).until(Playground.Result, Is.present()), - )).to.be.fulfilled. - - then(() => Promise.all([ - expect(james.toSee(WebElement.of(Playground.Result))).displayed, - expect(james.toSee(WebElement.of(Playground.Result))).present, - ]))); - }); - - describe('to determine if an element is not present in the DOM', () => { - - it('will fail if the condition is not met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Absent').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Not_Long_Enough).until(Playground.Result, Is.absent()), - )).to.be.rejectedWith('The result did not become absent')); - - it('will pass if the condition is met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Absent').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Long_Enough).until(Playground.Result, Is.absent()), - )).to.be.fulfilled. - - then(() => Promise.all([ - expect(james.toSee(WebElement.of(Playground.Result))).not.present, - ]))); - }); - - describe('to determine if an element is selected', () => { - - it('will fail if the condition is not met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Selected').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Not_Long_Enough).until(Playground.Result, Is.selected()), - )).to.be.rejectedWith('The result did not become selected')); - - it('will pass if the condition is met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Selected').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Long_Enough).until(Playground.Result, Is.selected()), - )).to.be.fulfilled. - - then(() => Promise.all([ - expect(james.toSee(WebElement.of(Playground.Result))).present, - expect(james.toSee(WebElement.of(Playground.Result))).displayed, - expect(james.toSee(WebElement.of(Playground.Result))).selected, - ]))); - }); - - describe('to determine if an element is clickable', () => { - - it('will fail if the condition is not met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Clickable').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Not_Long_Enough).until(Playground.Result, Is.clickable()), - )).to.be.rejectedWith('The result did not become clickable')); - - it('will pass if the condition is met within the timeout', () => - - expect(james.attemptsTo( - ChooseAnExample.whereElementBecomes('Clickable').after(Trigger_Delay).using(timeoutFunction), - Wait.upTo(Long_Enough).until(Playground.Result, Is.clickable()), - )).to.be.fulfilled. - - then(() => Promise.all([ - expect(james.toSee(WebElement.of(Playground.Result))).present, - expect(james.toSee(WebElement.of(Playground.Result))).displayed, - ]))); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/cookbook/windows.recipe.ts b/packages/serenity-js/spec/cookbook/windows.recipe.ts deleted file mode 100644 index bc182cea5e2..00000000000 --- a/packages/serenity-js/spec/cookbook/windows.recipe.ts +++ /dev/null @@ -1,70 +0,0 @@ -import expect = require('../expect'); - -import { by, protractor } from 'protractor'; - -import { Actor, BrowseTheWeb, See, Switch, Target, UseAngular } from '../../src/screenplay-protractor'; -import { Click, Open, Text } from '../../src/serenity-protractor'; - -import { AppServer } from '../support/server'; - -class Popup { - static Trigger = Target.the('pop up trigger').located(by.linkText('open a popup')); - static Text = Target.the('text of the pop-up').located(by.tagName('body')); - static Dismiss = Target.the('dismiss popup button').located(by.tagName('input')); -} - -describe ('When demonstrating how to work with popup windows, a test scenario', function() { - - this.timeout(10000); - - const app = new AppServer(); - const james = Actor.named('James').whoCan(BrowseTheWeb.using(protractor.browser)); - - before(app.start()); - before(() => james.attemptsTo(Open.browserOn(app.demonstrating('windows')))); - after(app.stop()); - - it ('can switch to a newly opened popup window and back', () => - james.attemptsTo( - Click.on(Popup.Trigger), - - UseAngular.disableSynchronisation(), - Switch.toPopupWindow(), - - See.if(Text.of(Popup.Text), text => expect(text).to.eventually.equal('Yup, it\'s a pop-up!')), - Click.on(Popup.Dismiss), - - UseAngular.enableSynchronisation(), - Switch.toParentWindow(), - - See.if(Text.of(Popup.Trigger), text => expect(text).to.eventually.equal('open a popup')), - )); - - // todo: fails; analyse why - xit ('can switch to a specific window identified by its index', () => - james.attemptsTo( - Click.on(Popup.Trigger), - Click.on(Popup.Trigger), - - UseAngular.disableSynchronisation(), - - Switch.toWindowNumber(2), - See.if(Text.of(Popup.Text), text => expect(text).to.eventually.equal('Yup, it\'s a pop-up!')), - Click.on(Popup.Dismiss), - - Switch.toWindowNumber(1), - See.if(Text.of(Popup.Text), text => expect(text).to.eventually.equal('Yup, it\'s a pop-up!')), - Click.on(Popup.Dismiss), - - UseAngular.enableSynchronisation(), - Switch.toParentWindow(), - - See.if(Text.of(Popup.Trigger), text => expect(text).to.eventually.equal('open a popup')), - )); - - // todo: fails; analyse why - xit ('complains when you try to switch to a popup that does not exist', () => - expect(james.attemptsTo( - Switch.toPopupWindow(), - )).to.eventually.be.rejectedWith('No popup window was opened')); -}); diff --git a/packages/serenity-js/spec/expect.ts b/packages/serenity-js/spec/expect.ts deleted file mode 100644 index e4ae231b2e0..00000000000 --- a/packages/serenity-js/spec/expect.ts +++ /dev/null @@ -1,67 +0,0 @@ -import chai = require('chai'); - -import sinonChai = require('sinon-chai'); -import chaiAsPromised = require('chai-as-promised'); -import chaiSmoothie = require('chai-smoothie'); -import { RecordedActivity, SourceLocation } from '@serenity-js/core/lib/domain/model'; - -// tslint:disable-next-line -chai.config['proxyExcludedKeys'].push('catch'); // todo: remove when domenic/chai-as-promised/#220 is addressed - -chai.use(sinonChai); -chai.use(chaiAsPromised); -chai.use(chaiSmoothie); - -declare global { - namespace Chai { // tslint:disable-line:no-namespace - interface Assertion { - recorded: Assertion; - as(name: string): Assertion; - calledAt(expected_location: { path?: string, line?: number, column?: number }): Assertion; - } - } -} - -chai.use(function(chai, utils) { - const Assertion = chai.Assertion; - - Assertion.addProperty('recorded', function() { - new Assertion(this._obj).to.be.instanceof(RecordedActivity); - }); - - Assertion.addMethod('as', function(expected_name) { - new Assertion(this._obj.name).to.equal(expected_name); - }); - - Assertion.addMethod('calledAt', function(expected_location: SourceLocation) { - - if (! this._obj.location) { - throw new TypeError(`${ this._obj } does not have a 'location' property`); - } - - if (expected_location.path) { - new Assertion( - this._obj.location.path, - `Expected '${this._obj}' to have been called from ${expected_location.path}, not ${this._obj.location.path}`, - ).contains(expected_location.path); - } - - if (expected_location.line) { - new Assertion( - this._obj.location.line, - `Expected '${this._obj}' to have been called on line ${expected_location.line}, not ${this._obj.location.line}`, - ).equal(expected_location.line); - } - - if (expected_location.column) { - new Assertion( - this._obj.location.column, - `Expected '${this._obj}' to have been called at column ${expected_location.column}, not ${this._obj.location.column}`, - ).equal(expected_location.column); - } - }); -}); - -const expect = chai.expect; - -export = expect; diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_a_failing_scenario.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_a_failing_scenario.feature deleted file mode 100644 index e707b07a437..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_a_failing_scenario.feature +++ /dev/null @@ -1,13 +0,0 @@ -Feature: Recognises a failing scenario - - Scenario: A failing scenario with a synchronous interface - Given a step that fails with a synchronous interface - - Scenario: A failing scenario with a callback interface - Given a step that fails with a callback interface - - Scenario: A failing scenario with a promise interface - Given a step that fails with a promise interface - - Scenario: A failing scenario with a generator interface - Given a step that fails with a generator interface diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_a_passing_scenario.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_a_passing_scenario.feature deleted file mode 100644 index 82ccc26261b..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_a_passing_scenario.feature +++ /dev/null @@ -1,13 +0,0 @@ -Feature: Recognises a passing scenario - - Scenario: A passing scenario with a synchronous interface - Given a step that passes with a synchronous interface - - Scenario: A passing scenario with a callback interface - Given a step that passes with a callback interface - - Scenario: A passing scenario with a promise interface - Given a step that passes with a promise interface - - Scenario: A passing scenario with a generator interface - Given a step that passes with a generator interface diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_a_skipped_scenario.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_a_skipped_scenario.feature deleted file mode 100644 index 1e2f9a697c8..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_a_skipped_scenario.feature +++ /dev/null @@ -1,5 +0,0 @@ -Feature: Recognises a skipped scenario - - @wip - Scenario: A skipped scenario - Given a scenario that is never executed \ No newline at end of file diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_an_explicitly_pending_scenario.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_an_explicitly_pending_scenario.feature deleted file mode 100644 index 98d0ecabbe3..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_an_explicitly_pending_scenario.feature +++ /dev/null @@ -1,13 +0,0 @@ -Feature: Recognises explicitly pending scenarios - - Scenario: An explicitly pending synchronous scenario - Given a pending step with a synchronous interface - - Scenario: An explicitly pending callback scenario - Given a pending step with a callback interface - - Scenario: An explicitly pending promise scenario - Given a pending step with a promise interface - - Scenario: An explicitly pending generator scenario - Given a pending step with a generator interface diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_an_implicitly_pending_scenario.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_an_implicitly_pending_scenario.feature deleted file mode 100644 index 846660836b6..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_an_implicitly_pending_scenario.feature +++ /dev/null @@ -1,4 +0,0 @@ -Feature: Recognises an implicitly pending scenario - - Scenario: An implicitly pending scenario - Given a scenario with no defined steps diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_multi_value_tags.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_multi_value_tags.feature deleted file mode 100644 index a52fb32b10b..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_multi_value_tags.feature +++ /dev/null @@ -1,6 +0,0 @@ -@cucumber -Feature: Recognises scenario tags - - @regression @issues:MY-PROJECT-123,MY-PROJECT-789 - Scenario: A regression test covering two issues - Given a step that passes \ No newline at end of file diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_single_value_tags.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_single_value_tags.feature deleted file mode 100644 index 0ded436bd2b..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_single_value_tags.feature +++ /dev/null @@ -1,6 +0,0 @@ -@cucumber -Feature: Recognises scenario tags - - @regression @issue:MY-PROJECT-123 - Scenario: A regression test covering one issue - Given a step that passes diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_special_step_arguments.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_special_step_arguments.feature deleted file mode 100644 index 4618a1c54b5..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_special_step_arguments.feature +++ /dev/null @@ -1,19 +0,0 @@ -Feature: Recognises special step arguments - - # https://github.com/cucumber/cucumber-js/blob/b659dc887ee8e94149b2148e83857b6c653aa2fa/features/data_tables.feature - @datatable - Scenario: Reports a data table argument - - Given the following accounts: - | name | email | twitter | - | Jan | jan.molak@serenity.io | @JanMolak | - | John | john.smart@serenity.io | @wakaleo | - - @docstring - Scenario: Reports a DocString argument - - Given an example.ts file with the following contents: - """ - export const noop = (_) => _; - export const sum = (a, b) => a + b; - """ \ No newline at end of file diff --git a/packages/serenity-js/spec/integration/cucumber/features/recognises_tests_that_timed_out.feature b/packages/serenity-js/spec/integration/cucumber/features/recognises_tests_that_timed_out.feature deleted file mode 100644 index 41717880a34..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/recognises_tests_that_timed_out.feature +++ /dev/null @@ -1,10 +0,0 @@ -Feature: Recognises a failing scenario - - Scenario Outline: A scenario with a step that times out - Given a slow, step - - Examples: - | TYPE | - | callback | - | promise | - | generator | \ No newline at end of file diff --git a/packages/serenity-js/spec/integration/cucumber/features/step_definitions/steps.ts b/packages/serenity-js/spec/integration/cucumber/features/step_definitions/steps.ts deleted file mode 100644 index 10a4898e4b3..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/features/step_definitions/steps.ts +++ /dev/null @@ -1,138 +0,0 @@ -enum StepInterface { - SYNCHRONOUS, - CALLBACK, - PROMISE, - GENERATOR, -} - -enum StepResult { - SUCCESS, - FAILURE, - PENDING, -} - -function createFailingStep(stepInterface: StepInterface) { - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - process.nextTick(cb.bind(null, new Error('Assertion failed'))); - }; - case StepInterface.PROMISE: - return () => { - return new Promise((resolve, reject) => { - process.nextTick(() => { - reject(new Error('Assertion failed')); - }); - }); - }; - case StepInterface.GENERATOR: - return function*() { - yield new Promise(process.nextTick); - throw new Error('Assertion failed'); - }; - case StepInterface.SYNCHRONOUS: - default: - return () => { - throw new Error('Assertion failed'); - }; - } -} - -function createPassingStep(stepInterface: StepInterface, result: StepResult) { - const resultValue = StepResult[result].toLowerCase(); - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - process.nextTick(cb.bind(null, null, resultValue)); - }; - case StepInterface.PROMISE: - return () => { - return new Promise(resolve => process.nextTick(() => resolve(resultValue))); - }; - case StepInterface.GENERATOR: - return function*() { - yield new Promise(process.nextTick); - return resultValue; - }; - case StepInterface.SYNCHRONOUS: - default: - return () => { - return resultValue; - }; - } -} - -function createSlowStep(stepInterface: StepInterface, timeout: number) { - switch (stepInterface) { - case StepInterface.CALLBACK: - return cb => { - setTimeout(cb, timeout); - }; - case StepInterface.GENERATOR: - return function*() { - yield new Promise(resolve => setTimeout(resolve, timeout)); - }; - case StepInterface.PROMISE: - default: - return () => { - return new Promise(resolve => setTimeout(resolve, timeout)); - }; - } -} - -function createStep(stepInterface: StepInterface, result: StepResult) { - if (result === StepResult.FAILURE) { - return createFailingStep(stepInterface); - } - return createPassingStep(stepInterface, result); -} - -export = function() { - - this.Given(/^a step that passes$/, - createStep(StepInterface.PROMISE, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.SUCCESS)); - - this.Given(/^a step that passes with a generator interface$/, - createStep(StepInterface.GENERATOR, StepResult.SUCCESS)); - - this.Given(/^a step that fails with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.FAILURE)); - - this.Given(/^a step that fails with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.FAILURE)); - - this.Given(/^a step that fails with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.FAILURE)); - - this.Given(/^a step that fails with a generator interface$/, - createStep(StepInterface.GENERATOR, StepResult.FAILURE)); - - this.Given(/^a pending step with a synchronous interface$/, - createStep(StepInterface.SYNCHRONOUS, StepResult.PENDING)); - - this.Given(/^a pending step with a callback interface$/, - createStep(StepInterface.CALLBACK, StepResult.PENDING)); - - this.Given(/^a pending step with a promise interface$/, - createStep(StepInterface.PROMISE, StepResult.PENDING)); - - this.Given(/^a pending step with a generator interface$/, - createStep(StepInterface.GENERATOR, StepResult.PENDING)); - - this.Given(/^the following.*$/, data => Promise.resolve()); - - this.Given(/^an example.ts file with the following contents:$/, docstring => Promise.resolve()); - - this.Given(/^a slow, callback step$/, { timeout: 100 }, createSlowStep(StepInterface.CALLBACK, 10000)); - this.Given(/^a slow, generator step$/, { timeout: 100 }, createSlowStep(StepInterface.GENERATOR, 10000)); - this.Given(/^a slow, promise step$/, { timeout: 100 }, createSlowStep(StepInterface.PROMISE, 10000)); -}; diff --git a/packages/serenity-js/spec/integration/cucumber/handles_cucumber_cli_arguments.ts b/packages/serenity-js/spec/integration/cucumber/handles_cucumber_cli_arguments.ts deleted file mode 100644 index a2cf9e8c1da..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/handles_cucumber_cli_arguments.ts +++ /dev/null @@ -1,47 +0,0 @@ -import { Result, SceneFinished } from '@serenity-js/core/lib/domain'; -import { spawner } from '../../support/spawner'; - -import expect = require('../../expect'); - -describe('When working with Cucumber', function() { - - this.timeout(30 * 1000); // it might take a while to start up the selenium server - - const protractor = spawner( - process.cwd() + '/node_modules/.bin/protractor', - { cwd: __dirname, silent: true }, - ); - - describe('Serenity/JS', () => { - - it('correctly sets the strict mode when required', () => { - - const spawned = protractor('protractor.conf.js', - '--specs', '**/recognises_an_implicitly_pending_scenario.feature', - '--cucumberOpts.strict', 'true', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - const lastMessage = spawned.messages.pop(); - - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it('correctly disables the strict mode when required', () => { - - const spawned = protractor('protractor.conf.js', - '--specs', '**/recognises_an_implicitly_pending_scenario.feature', - '--cucumberOpts.strict', 'false', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - const lastMessage = spawned.messages.pop(); - - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/integration/cucumber/protractor.conf.js b/packages/serenity-js/spec/integration/cucumber/protractor.conf.js deleted file mode 100644 index 12916874bac..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/protractor.conf.js +++ /dev/null @@ -1,41 +0,0 @@ -'use strict'; -require('ts-node/register'); - -const - isCI = require('../../isCI'), - path = require('path'), - protractor = require.resolve('protractor'), - node_modules = protractor.substring(0, protractor.lastIndexOf('node_modules') + 12), - crew = require('../../support/child_process_reporter.ts'); - -exports.config = { - // seleniumServerJar: path.resolve(node_modules, 'protractor/node_modules/webdriver-manager/selenium/selenium-server-standalone-2.53.1.jar'), - - directConnect: true, - - framework: 'custom', - - frameworkPath: path.resolve(__dirname, '../../../src'), - serenity: { - dialect: 'cucumber', - crew: [ crew.childProcessReporter() ], - }, - - specs: [ 'features/**/*.feature' ], - cucumberOpts: { - require: [ - 'features/**/*.ts' - ], - format: 'pretty', - compiler: 'ts:ts-node/register', - }, - - capabilities: { - browserName: 'chrome', - - chromeOptions: { - args: [ "--headless", "--disable-gpu", "--window-size=800,600" ] - .concat(isCI() ? ['--no-sandbox'] : []) - } - }, -}; diff --git a/packages/serenity-js/spec/integration/cucumber/recognises_scenario_results.ts b/packages/serenity-js/spec/integration/cucumber/recognises_scenario_results.ts deleted file mode 100644 index 3736d7f1a38..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/recognises_scenario_results.ts +++ /dev/null @@ -1,94 +0,0 @@ -import { Result, SceneFinished } from '@serenity-js/core/lib/domain'; - -import expect = require('../../expect'); - -import * as _ from 'lodash'; -import { spawner } from '../../support/spawner'; - -describe('When working with Cucumber', function() { - - this.timeout(30 * 1000); // it might take a while to start up the selenium server - - const protractorSpawner = spawner( - process.cwd() + '/node_modules/.bin/protractor', - { cwd: __dirname, silent: true }, - ); - - const protractor = (specs: string) => protractorSpawner('protractor.conf.js', - '--specs', specs, - '--cucumberOpts.tags', '~@wip', - ); - - describe('Serenity/JS', () => { - - const stepApiTypes = 4; - const messagesPerStep = 6; - const messagesPerFeature = stepApiTypes * messagesPerStep; - - it ('reports passing scenarios', () => { - const spawned = protractor('**/*passing_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.SUCCESS]); - }); - }); - }); - - it ('ignores skipped scenarios', () => { - const spawned = protractor('**/*skipped_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(0); - }); - }); - - it ('reports implicitly pending scenarios', () => { - const spawned = protractor('**/*implicitly_pending_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerStep); - - const lastMessage = spawned.messages.pop(); - - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it ('reports explicitly pending scenarios', () => { - const spawned = protractor('**/*explicitly_pending_scenario.feature'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - }); - - it('reports failing scenarios', () => { - const spawned = protractor('**/*failing_scenario.feature'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.FAILURE]); - }); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/integration/cucumber/recognises_scenario_tags.ts b/packages/serenity-js/spec/integration/cucumber/recognises_scenario_tags.ts deleted file mode 100644 index 5c82c2c9674..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/recognises_scenario_tags.ts +++ /dev/null @@ -1,75 +0,0 @@ -import { RecordedScene, SceneFinished, SceneStarts, Tag } from '@serenity-js/core/lib/domain'; -import { lastOf } from '../../support/event_picker'; -import { spawner } from '../../support/spawner'; - -import expect = require('../../expect'); - -describe('When working with Cucumber', function() { - - this.timeout(30 * 1000); // it might take a while to start up the selenium server - - const protractor = spawner( - process.cwd() + '/node_modules/.bin/protractor', - { cwd: __dirname, silent: true }, - ); - - describe('Serenity/JS', () => { - - it('recognises single-value scenario tags', () => { - - const spawned = protractor('protractor.conf.js', - '--specs', '**/recognises_single_value_tags.feature', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - const sceneStarts = lastOf(SceneStarts, spawned.messages); - - expect(sceneStarts.value).to.be.instanceOf(RecordedScene); - expect(sceneStarts.value.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issue', [ 'MY-PROJECT-123' ]), - ]); - - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneFinished).to.be.instanceOf(SceneFinished); - expect(sceneFinished.value.subject).to.be.instanceOf(RecordedScene); - expect(sceneFinished.value.subject.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issue', [ 'MY-PROJECT-123' ]), - ]); - }); - }); - - it('recognises multi-value scenario tags', () => { - - const spawned = protractor('protractor.conf.js', - '--specs', '**/recognises_multi_value_tags.feature', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - const sceneStarts = lastOf(SceneStarts, spawned.messages); - - expect(sceneStarts).to.be.instanceOf(SceneStarts); - expect(sceneStarts.value).to.be.instanceOf(RecordedScene); - expect(sceneStarts.value.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issues', [ 'MY-PROJECT-123', 'MY-PROJECT-789' ]), - ]); - - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneFinished).to.be.instanceOf(SceneFinished); - expect(sceneFinished.value.subject).to.be.instanceOf(RecordedScene); - expect(sceneFinished.value.subject.tags).to.deep.equal([ - new Tag('cucumber'), - new Tag('regression'), - new Tag('issues', [ 'MY-PROJECT-123', 'MY-PROJECT-789' ]), - ]); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/integration/cucumber/recognises_special_step_arguments.ts b/packages/serenity-js/spec/integration/cucumber/recognises_special_step_arguments.ts deleted file mode 100644 index 05594348037..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/recognises_special_step_arguments.ts +++ /dev/null @@ -1,68 +0,0 @@ -import expect = require('../../expect'); - -import { ActivityFinished, ActivityStarts } from '@serenity-js/core/lib/domain'; -import { lastOf } from '../../support/event_picker'; -import { spawner } from '../../support/spawner'; - -describe('When working with Cucumber', function() { - - this.timeout(30 * 1000); // it might take a while to start up the selenium server - - const protractorSpawner = spawner( - process.cwd() + '/node_modules/.bin/protractor', - { cwd: __dirname, silent: true }, - ); - - const protractor = (specs: string, tag: string) => protractorSpawner('protractor.conf.js', - '--specs', specs, - '--cucumberOpts.tags', tag, - ); - - describe('Serenity/JS', () => { - - const messagesPerStep = 6; - - it ('reports data table arguments', () => { - const spawned = protractor('**/*special_step_arguments.feature', '@datatable'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerStep); - - const - cucumberStepDescriptionFromActivityStartedMessage = lastOf(ActivityStarts, spawned.messages).value.name, - cucumberStepDescriptionFromActivityFinishedMessage = lastOf(ActivityFinished, spawned.messages).value.subject.name; - - expect(cucumberStepDescriptionFromActivityStartedMessage).to.equal([ - 'Given the following accounts:', - '| name | email | twitter |', - '| Jan | jan.molak@serenity.io | @JanMolak |', - '| John | john.smart@serenity.io | @wakaleo |', - ].join('\n')); - - expect(cucumberStepDescriptionFromActivityStartedMessage). - to.equal(cucumberStepDescriptionFromActivityFinishedMessage); - }); - }); - - it ('reports DocString arguments', () => { - const spawned = protractor('**/*special_step_arguments.feature', '@docstring'); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerStep); - - const - cucumberStepDescriptionFromActivityStartedMessage = lastOf(ActivityStarts, spawned.messages).value.name, - cucumberStepDescriptionFromActivityFinishedMessage = lastOf(ActivityFinished, spawned.messages).value.subject.name; - - expect(cucumberStepDescriptionFromActivityStartedMessage).to.equal([ - 'Given an example.ts file with the following contents:', - 'export const noop = (_) => _;', - 'export const sum = (a, b) => a + b;', - ].join('\n')); - - expect(cucumberStepDescriptionFromActivityStartedMessage). - to.equal(cucumberStepDescriptionFromActivityFinishedMessage); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/integration/cucumber/recognises_timed_out_scenarios.ts b/packages/serenity-js/spec/integration/cucumber/recognises_timed_out_scenarios.ts deleted file mode 100644 index 0bcff9cf8bc..00000000000 --- a/packages/serenity-js/spec/integration/cucumber/recognises_timed_out_scenarios.ts +++ /dev/null @@ -1,44 +0,0 @@ -import { Result, SceneFinished } from '@serenity-js/core/lib/domain'; - -import expect = require('../../expect'); - -import * as _ from 'lodash'; -import { spawner } from '../../support/spawner'; - -describe('When working with Cucumber', function() { - - this.timeout(30 * 1000); // it might take a while to start up the selenium server - - const protractorSpawner = spawner( - process.cwd() + '/node_modules/.bin/protractor', - { cwd: __dirname, silent: true }, - ); - - const protractor = (specs: string) => protractorSpawner('protractor.conf.js', - '--specs', specs, - '--cucumberOpts.tags', '~@wip', - ); - - describe('Serenity/JS', () => { - - const stepApiTypes = 3; - const messagesPerStep = 6; - const messagesPerFeature = stepApiTypes * messagesPerStep; - - it ('reports timed-out scenarios', () => { - const spawned = protractor('**/*timed_out.feature'); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.lengthOf(messagesPerFeature); - - const lastMessages = _.chunk(spawned.messages, messagesPerStep).map(chunk => chunk.pop()); - - lastMessages.forEach(lastMessage => { - expect(lastMessage).to.be.instanceOf(SceneFinished); - expect(Result[lastMessage.value.result]).to.equal(Result[Result.ERROR]); - expect(lastMessage.value.error.message).to.match(/function timed out/); - }); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/integration/mocha/protractor.conf.js b/packages/serenity-js/spec/integration/mocha/protractor.conf.js deleted file mode 100644 index 5372528520b..00000000000 --- a/packages/serenity-js/spec/integration/mocha/protractor.conf.js +++ /dev/null @@ -1,40 +0,0 @@ -'use strict'; - -require('ts-node/register'); // because of the child_process_reporter.ts - -const - isCI = require('../../isCI'), - path = require('path'), - protractor = require.resolve('protractor'), - node_modules = protractor.substring(0, protractor.lastIndexOf('node_modules') + 12), - crew = require('../../support/child_process_reporter.ts'); - -exports.config = { - // seleniumServerJar: path.resolve(node_modules, 'protractor/node_modules/webdriver-manager/selenium/selenium-server-standalone-2.53.1.jar'), - - directConnect: true, - - framework: 'custom', - - frameworkPath: path.resolve(__dirname, '../../../src'), - serenity: { - dialect: 'mocha', - crew: [ crew.childProcessReporter() ], - }, - - specs: [ 'spec/**.ts' ], - - mochaOpts: { - ui: 'bdd', - compiler: 'ts:ts-node/register', - }, - - capabilities: { - browserName: 'chrome', - - chromeOptions: { - args: [ "--headless", "--disable-gpu", "--window-size=800,600" ] - .concat(isCI() ? ['--no-sandbox'] : []) - } - }, -}; diff --git a/packages/serenity-js/spec/integration/mocha/recognises_scenario_results.ts b/packages/serenity-js/spec/integration/mocha/recognises_scenario_results.ts deleted file mode 100644 index 029e107a522..00000000000 --- a/packages/serenity-js/spec/integration/mocha/recognises_scenario_results.ts +++ /dev/null @@ -1,195 +0,0 @@ -import expect = require('../../expect'); - -import { Result, SceneFinished, SceneStarts } from '@serenity-js/core/lib/domain'; -import { lastOf } from '../../support/event_picker'; -import { spawner } from '../../support/spawner'; - -describe('When working with Mocha', function() { - - this.timeout(30 * 1000); // it might take a while to start up the selenium server - - const protractor = spawner( - process.cwd() + '/node_modules/.bin/protractor', - { cwd: __dirname, silent: true }, - ); - - // todo: tags: https://medium.com/@andrew_levine/tagging-tests-w-protractor-and-mocha-20b20bc10322#.cngxajsbf - - describe('Serenity/JS', () => { - - it ('reports passing scenarios', () => { - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that passes', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.SUCCESS]); - }); - }); - - it ('reports pending scenarios', () => { - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that is pending', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it ('reports skipped scenarios', () => { - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that is skipped', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.PENDING]); - }); - }); - - it('reports sync scenarios failing due to an AssertionError', () => { - - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that fails due to an AssertionError', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.FAILURE]); - }); - }); - - it('reports async scenarios failing due to an AssertionError', () => { - - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'ails due to an async AssertionError', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.FAILURE]); - expect(event.value.error).to.deep.equal({ - actual: 'async pass', - expected: 'async fail', - message: 'expected \'async pass\' to equal \'async fail\'', - name: 'AssertionError', - showDiff: true, - }); - }); - }); - - it('reports scenarios that timed out', () => { - - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that times out', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.ERROR]); - expect(event.value.error.message).to.match(/Timeout of 5ms exceeded./); - }); - }); - - it('reports scenarios that failed with an error', () => { - - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that fails with an error', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.ERROR]); - expect(event.value.error.message).to.match(/Expected problem/); - }); - }); - - it('reports scenarios that failed with an error asynchronously', () => { - - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that asynchronously fails with an error', - ); - - return expect(spawned.result).to.be.eventually.rejected.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const event = lastOf(SceneFinished, spawned.messages); - - expect(Result[event.value.result]).to.equal(Result[Result.ERROR]); - expect(event.value.error.message).to.match(/Expected async problem/); - }); - }); - - it ('recognises the name of the feature under test (the outer-most `describe`)', () => { - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that passes', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const sceneStarts = lastOf(SceneStarts, spawned.messages); - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneStarts.value.category).to.equal('Integration with Mocha'); - expect(sceneFinished.value.subject.category).to.equal('Integration with Mocha'); - }); - }); - - it ('recognises the name of the scenario', () => { - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A sample test that passes', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const sceneStarts = lastOf(SceneStarts, spawned.messages); - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneStarts.value.name).to.equal('A sample test that passes'); - expect(sceneFinished.value.subject.name).to.equal('A sample test that passes'); - }); - }); - - it ('treats a scenario with setup and teardown just like any other scenario', () => { - const spawned = protractor('protractor.conf.js', - '--mochaOpts.grep', 'A test with both setup and teardown that passes', - ); - - return expect(spawned.result).to.be.eventually.fulfilled.then(() => { - expect(spawned.messages).to.have.length.greaterThan(2); - - const sceneStarts = lastOf(SceneStarts, spawned.messages); - const sceneFinished = lastOf(SceneFinished, spawned.messages); - - expect(sceneStarts.value.name).to.equal('A test with both setup and teardown that passes'); - expect(sceneFinished.value.subject.name).to.equal('A test with both setup and teardown that passes'); - }); - }); - }); -}); diff --git a/packages/serenity-js/spec/integration/mocha/spec/results.spec.ts b/packages/serenity-js/spec/integration/mocha/spec/results.spec.ts deleted file mode 100644 index e5bfd2f0582..00000000000 --- a/packages/serenity-js/spec/integration/mocha/spec/results.spec.ts +++ /dev/null @@ -1,53 +0,0 @@ -import expect = require('../../../expect'); - -describe ('Integration with Mocha', () => { - - describe ('A sample test that', () => { - - it ('passes', () => { - expect('pass').to.equal('pass'); - }); - - it ('fails due to an AssertionError', () => { - expect('pass').to.equal('fail'); - }); - - it ('fails due to an async AssertionError', () => { - return expect(Promise.resolve('async pass')).to.eventually.equal('async fail'); - }); - - it ('is pending'); - - xit ('is skipped', () => { - expect('pass').to.equal('fail'); - }); - - it ('times out', function(done) { - this.timeout(5); - - setTimeout(done, 100); - }); - - it ('fails with an error', () => { - throw new Error('Expected problem'); - }); - - it ('asynchronously fails with an error', () => Promise.reject(new Error('Expected async problem'))); - }); - - describe ('A test with both setup and teardown that', () => { - - beforeEach(() => { - // setup - }); - - it ('passes', () => { - expect('pass').to.equal('pass'); - }); - - afterEach(() => { - // teardown - }); - }); - -}); diff --git a/packages/serenity-js/spec/isCI.js b/packages/serenity-js/spec/isCI.js deleted file mode 100644 index d68f68a93bf..00000000000 --- a/packages/serenity-js/spec/isCI.js +++ /dev/null @@ -1,4 +0,0 @@ -module.exports = function isCI() { - return process.env.CI && process.env.CI === 'true'; -}; - diff --git a/packages/serenity-js/spec/protractor-cookbook.conf.js b/packages/serenity-js/spec/protractor-cookbook.conf.js deleted file mode 100644 index ffec3d78706..00000000000 --- a/packages/serenity-js/spec/protractor-cookbook.conf.js +++ /dev/null @@ -1,21 +0,0 @@ -'use strict'; -require('ts-node/register'); - -const isCI = require('./isCI'); - -exports.config = { - directConnect: true, - framework: 'mocha', - specs: ['cookbook/**/*.recipe.ts'], - - restartBrowserBetweenTests: false, - - capabilities: { - browserName: 'chrome', - - chromeOptions: { - args: [ "--headless", "--disable-gpu", "--window-size=800,600" ] - .concat(isCI() ? ['--no-sandbox'] : []) - } - } -}; diff --git a/packages/serenity-js/spec/support/child_process_reporter.ts b/packages/serenity-js/spec/support/child_process_reporter.ts deleted file mode 100644 index e1d6a10a9b4..00000000000 --- a/packages/serenity-js/spec/support/child_process_reporter.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { DomainEvent } from '@serenity-js/core/lib/domain'; -import { StageCrewMember } from '@serenity-js/core/lib/stage'; - -export class ChildProcessReporter implements StageCrewMember { - constructor() { - this.enableSerialisationOfErrors(); - } - - assignTo(stage) { - stage.manager.registerInterestIn([ DomainEvent ], this); - } - - notifyOf(event) { - process.send(event); - } - - private enableSerialisationOfErrors() { - if (! ('toJSON' in Error.prototype)) { - Object.defineProperty(Error.prototype, 'toJSON', { - value: function() { // tslint:disable-line:object-literal-shorthand needed for `this` to work - const alt = {}; - - Object.getOwnPropertyNames(this).forEach(function(key) { - alt[key] = this[key]; - }, this); - - return alt; - }, - configurable: true, - writable: true, - }); - } - } -} - -export function childProcessReporter() { - return new ChildProcessReporter(); -} diff --git a/packages/serenity-js/spec/support/event_picker.ts b/packages/serenity-js/spec/support/event_picker.ts deleted file mode 100644 index 07c4e0ccb1f..00000000000 --- a/packages/serenity-js/spec/support/event_picker.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { DomainEvent } from '@serenity-js/core/lib/domain'; - -export const lastOf = (type: typeof DomainEvent, events: Array>) => events.filter(e => e instanceof type).pop(); diff --git a/packages/serenity-js/spec/support/server/css/bootstrap.min.css b/packages/serenity-js/spec/support/server/css/bootstrap.min.css deleted file mode 100644 index 06cf582157e..00000000000 --- a/packages/serenity-js/spec/support/server/css/bootstrap.min.css +++ /dev/null @@ -1,7 +0,0 @@ -/*! - * Bootstrap v4.0.0-alpha.5 (https://getbootstrap.com) - * Copyright 2011-2016 The Bootstrap Authors - * Copyright 2011-2016 Twitter, Inc. - * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) - *//*! normalize.css v4.2.0 | MIT License | github.com/necolas/normalize.css */html{font-family:sans-serif;line-height:1.15;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block}audio:not([controls]){display:none;height:0}progress{vertical-align:baseline}[hidden],template{display:none}a{background-color:transparent;-webkit-text-decoration-skip:objects}a:active,a:hover{outline-width:0}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:inherit}b,strong{font-weight:bolder}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}svg:not(:root){overflow:hidden}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}figure{margin:1em 40px}hr{-webkit-box-sizing:content-box;box-sizing:content-box;height:0;overflow:visible}button,input,optgroup,select,textarea{font:inherit;margin:0}optgroup{font-weight:700}button,input{overflow:visible}button,select{text-transform:none}[type=reset],[type=submit],button,html [type=button]{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{-webkit-box-sizing:border-box;box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}textarea{overflow:auto}[type=checkbox],[type=radio]{-webkit-box-sizing:border-box;box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-input-placeholder{color:inherit;opacity:.54}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}@media print{*,::after,::before,::first-letter,blockquote::first-line,div::first-line,li::first-line,p::first-line{text-shadow:none!important;-webkit-box-shadow:none!important;box-shadow:none!important}a,a:visited{text-decoration:underline}abbr[title]::after{content:" (" attr(title) ")"}pre{white-space:pre-wrap!important}blockquote,pre{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000!important}.tag{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #ddd!important}}html{-webkit-box-sizing:border-box;box-sizing:border-box}*,::after,::before{-webkit-box-sizing:inherit;box-sizing:inherit}@-ms-viewport{width:device-width}html{font-size:16px;-ms-overflow-style:scrollbar;-webkit-tap-highlight-color:transparent}body{font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;font-size:1rem;line-height:1.5;color:#373a3c;background-color:#fff}[tabindex="-1"]:focus{outline:0!important}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem}p{margin-top:0;margin-bottom:1rem}abbr[data-original-title],abbr[title]{cursor:help;border-bottom:1px dotted #818a91}address{margin-bottom:1rem;font-style:normal;line-height:inherit}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}a{color:#0275d8;text-decoration:none}a:focus,a:hover{color:#014c8c;text-decoration:underline}a:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}a:not([href]):not([tabindex]){color:inherit;text-decoration:none}a:not([href]):not([tabindex]):focus,a:not([href]):not([tabindex]):hover{color:inherit;text-decoration:none}a:not([href]):not([tabindex]):focus{outline:0}pre{margin-top:0;margin-bottom:1rem;overflow:auto}figure{margin:0 0 1rem}img{vertical-align:middle}[role=button]{cursor:pointer}[role=button],a,area,button,input,label,select,summary,textarea{-ms-touch-action:manipulation;touch-action:manipulation}table{border-collapse:collapse;background-color:transparent}caption{padding-top:.75rem;padding-bottom:.75rem;color:#818a91;text-align:left;caption-side:bottom}th{text-align:left}label{display:inline-block;margin-bottom:.5rem}button:focus{outline:1px dotted;outline:5px auto -webkit-focus-ring-color}button,input,select,textarea{line-height:inherit}input[type=checkbox]:disabled,input[type=radio]:disabled{cursor:not-allowed}input[type=date],input[type=time],input[type=datetime-local],input[type=month]{-webkit-appearance:listbox}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:.5rem;font-size:1.5rem;line-height:inherit}input[type=search]{-webkit-appearance:none}output{display:inline-block}[hidden]{display:none!important}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{margin-bottom:.5rem;font-family:inherit;font-weight:500;line-height:1.1;color:inherit}.h1,h1{font-size:2.5rem}.h2,h2{font-size:2rem}.h3,h3{font-size:1.75rem}.h4,h4{font-size:1.5rem}.h5,h5{font-size:1.25rem}.h6,h6{font-size:1rem}.lead{font-size:1.25rem;font-weight:300}.display-1{font-size:6rem;font-weight:300}.display-2{font-size:5.5rem;font-weight:300}.display-3{font-size:4.5rem;font-weight:300}.display-4{font-size:3.5rem;font-weight:300}hr{margin-top:1rem;margin-bottom:1rem;border:0;border-top:1px solid rgba(0,0,0,.1)}.small,small{font-size:80%;font-weight:400}.mark,mark{padding:.2em;background-color:#fcf8e3}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;list-style:none}.list-inline-item{display:inline-block}.list-inline-item:not(:last-child){margin-right:5px}.initialism{font-size:90%;text-transform:uppercase}.blockquote{padding:.5rem 1rem;margin-bottom:1rem;font-size:1.25rem;border-left:.25rem solid #eceeef}.blockquote-footer{display:block;font-size:80%;color:#818a91}.blockquote-footer::before{content:"\2014 \00A0"}.blockquote-reverse{padding-right:1rem;padding-left:0;text-align:right;border-right:.25rem solid #eceeef;border-left:0}.blockquote-reverse .blockquote-footer::before{content:""}.blockquote-reverse .blockquote-footer::after{content:"\00A0 \2014"}dl.row>dd+dt{clear:left}.carousel-inner>.carousel-item>a>img,.carousel-inner>.carousel-item>img,.img-fluid{max-width:100%;height:auto}.img-thumbnail{padding:.25rem;background-color:#fff;border:1px solid #ddd;border-radius:.25rem;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out;max-width:100%;height:auto}.figure{display:inline-block}.figure-img{margin-bottom:.5rem;line-height:1}.figure-caption{font-size:90%;color:#818a91}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace}code{padding:.2rem .4rem;font-size:90%;color:#bd4147;background-color:#f7f7f9;border-radius:.25rem}kbd{padding:.2rem .4rem;font-size:90%;color:#fff;background-color:#333;border-radius:.2rem}kbd kbd{padding:0;font-size:100%;font-weight:700}pre{display:block;margin-top:0;margin-bottom:1rem;font-size:90%;color:#373a3c}pre code{padding:0;font-size:inherit;color:inherit;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px}.container::after{content:"";display:table;clear:both}@media (min-width:576px){.container{width:540px;max-width:100%}}@media (min-width:768px){.container{width:720px;max-width:100%}}@media (min-width:992px){.container{width:960px;max-width:100%}}@media (min-width:1200px){.container{width:1140px;max-width:100%}}.container-fluid{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px}.container-fluid::after{content:"";display:table;clear:both}.row{margin-right:-15px;margin-left:-15px}.row::after{content:"";display:table;clear:both}@media (min-width:576px){.row{margin-right:-15px;margin-left:-15px}}@media (min-width:768px){.row{margin-right:-15px;margin-left:-15px}}@media (min-width:992px){.row{margin-right:-15px;margin-left:-15px}}@media (min-width:1200px){.row{margin-right:-15px;margin-left:-15px}}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xs,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{position:relative;min-height:1px;padding-right:15px;padding-left:15px}@media (min-width:576px){.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xs,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{padding-right:15px;padding-left:15px}}@media (min-width:768px){.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xs,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{padding-right:15px;padding-left:15px}}@media (min-width:992px){.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xs,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{padding-right:15px;padding-left:15px}}@media (min-width:1200px){.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xs,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{padding-right:15px;padding-left:15px}}.col-xs-1{float:left;width:8.333333%}.col-xs-2{float:left;width:16.666667%}.col-xs-3{float:left;width:25%}.col-xs-4{float:left;width:33.333333%}.col-xs-5{float:left;width:41.666667%}.col-xs-6{float:left;width:50%}.col-xs-7{float:left;width:58.333333%}.col-xs-8{float:left;width:66.666667%}.col-xs-9{float:left;width:75%}.col-xs-10{float:left;width:83.333333%}.col-xs-11{float:left;width:91.666667%}.col-xs-12{float:left;width:100%}.pull-xs-0{right:auto}.pull-xs-1{right:8.333333%}.pull-xs-2{right:16.666667%}.pull-xs-3{right:25%}.pull-xs-4{right:33.333333%}.pull-xs-5{right:41.666667%}.pull-xs-6{right:50%}.pull-xs-7{right:58.333333%}.pull-xs-8{right:66.666667%}.pull-xs-9{right:75%}.pull-xs-10{right:83.333333%}.pull-xs-11{right:91.666667%}.pull-xs-12{right:100%}.push-xs-0{left:auto}.push-xs-1{left:8.333333%}.push-xs-2{left:16.666667%}.push-xs-3{left:25%}.push-xs-4{left:33.333333%}.push-xs-5{left:41.666667%}.push-xs-6{left:50%}.push-xs-7{left:58.333333%}.push-xs-8{left:66.666667%}.push-xs-9{left:75%}.push-xs-10{left:83.333333%}.push-xs-11{left:91.666667%}.push-xs-12{left:100%}.offset-xs-1{margin-left:8.333333%}.offset-xs-2{margin-left:16.666667%}.offset-xs-3{margin-left:25%}.offset-xs-4{margin-left:33.333333%}.offset-xs-5{margin-left:41.666667%}.offset-xs-6{margin-left:50%}.offset-xs-7{margin-left:58.333333%}.offset-xs-8{margin-left:66.666667%}.offset-xs-9{margin-left:75%}.offset-xs-10{margin-left:83.333333%}.offset-xs-11{margin-left:91.666667%}@media (min-width:576px){.col-sm-1{float:left;width:8.333333%}.col-sm-2{float:left;width:16.666667%}.col-sm-3{float:left;width:25%}.col-sm-4{float:left;width:33.333333%}.col-sm-5{float:left;width:41.666667%}.col-sm-6{float:left;width:50%}.col-sm-7{float:left;width:58.333333%}.col-sm-8{float:left;width:66.666667%}.col-sm-9{float:left;width:75%}.col-sm-10{float:left;width:83.333333%}.col-sm-11{float:left;width:91.666667%}.col-sm-12{float:left;width:100%}.pull-sm-0{right:auto}.pull-sm-1{right:8.333333%}.pull-sm-2{right:16.666667%}.pull-sm-3{right:25%}.pull-sm-4{right:33.333333%}.pull-sm-5{right:41.666667%}.pull-sm-6{right:50%}.pull-sm-7{right:58.333333%}.pull-sm-8{right:66.666667%}.pull-sm-9{right:75%}.pull-sm-10{right:83.333333%}.pull-sm-11{right:91.666667%}.pull-sm-12{right:100%}.push-sm-0{left:auto}.push-sm-1{left:8.333333%}.push-sm-2{left:16.666667%}.push-sm-3{left:25%}.push-sm-4{left:33.333333%}.push-sm-5{left:41.666667%}.push-sm-6{left:50%}.push-sm-7{left:58.333333%}.push-sm-8{left:66.666667%}.push-sm-9{left:75%}.push-sm-10{left:83.333333%}.push-sm-11{left:91.666667%}.push-sm-12{left:100%}.offset-sm-0{margin-left:0%}.offset-sm-1{margin-left:8.333333%}.offset-sm-2{margin-left:16.666667%}.offset-sm-3{margin-left:25%}.offset-sm-4{margin-left:33.333333%}.offset-sm-5{margin-left:41.666667%}.offset-sm-6{margin-left:50%}.offset-sm-7{margin-left:58.333333%}.offset-sm-8{margin-left:66.666667%}.offset-sm-9{margin-left:75%}.offset-sm-10{margin-left:83.333333%}.offset-sm-11{margin-left:91.666667%}}@media (min-width:768px){.col-md-1{float:left;width:8.333333%}.col-md-2{float:left;width:16.666667%}.col-md-3{float:left;width:25%}.col-md-4{float:left;width:33.333333%}.col-md-5{float:left;width:41.666667%}.col-md-6{float:left;width:50%}.col-md-7{float:left;width:58.333333%}.col-md-8{float:left;width:66.666667%}.col-md-9{float:left;width:75%}.col-md-10{float:left;width:83.333333%}.col-md-11{float:left;width:91.666667%}.col-md-12{float:left;width:100%}.pull-md-0{right:auto}.pull-md-1{right:8.333333%}.pull-md-2{right:16.666667%}.pull-md-3{right:25%}.pull-md-4{right:33.333333%}.pull-md-5{right:41.666667%}.pull-md-6{right:50%}.pull-md-7{right:58.333333%}.pull-md-8{right:66.666667%}.pull-md-9{right:75%}.pull-md-10{right:83.333333%}.pull-md-11{right:91.666667%}.pull-md-12{right:100%}.push-md-0{left:auto}.push-md-1{left:8.333333%}.push-md-2{left:16.666667%}.push-md-3{left:25%}.push-md-4{left:33.333333%}.push-md-5{left:41.666667%}.push-md-6{left:50%}.push-md-7{left:58.333333%}.push-md-8{left:66.666667%}.push-md-9{left:75%}.push-md-10{left:83.333333%}.push-md-11{left:91.666667%}.push-md-12{left:100%}.offset-md-0{margin-left:0%}.offset-md-1{margin-left:8.333333%}.offset-md-2{margin-left:16.666667%}.offset-md-3{margin-left:25%}.offset-md-4{margin-left:33.333333%}.offset-md-5{margin-left:41.666667%}.offset-md-6{margin-left:50%}.offset-md-7{margin-left:58.333333%}.offset-md-8{margin-left:66.666667%}.offset-md-9{margin-left:75%}.offset-md-10{margin-left:83.333333%}.offset-md-11{margin-left:91.666667%}}@media (min-width:992px){.col-lg-1{float:left;width:8.333333%}.col-lg-2{float:left;width:16.666667%}.col-lg-3{float:left;width:25%}.col-lg-4{float:left;width:33.333333%}.col-lg-5{float:left;width:41.666667%}.col-lg-6{float:left;width:50%}.col-lg-7{float:left;width:58.333333%}.col-lg-8{float:left;width:66.666667%}.col-lg-9{float:left;width:75%}.col-lg-10{float:left;width:83.333333%}.col-lg-11{float:left;width:91.666667%}.col-lg-12{float:left;width:100%}.pull-lg-0{right:auto}.pull-lg-1{right:8.333333%}.pull-lg-2{right:16.666667%}.pull-lg-3{right:25%}.pull-lg-4{right:33.333333%}.pull-lg-5{right:41.666667%}.pull-lg-6{right:50%}.pull-lg-7{right:58.333333%}.pull-lg-8{right:66.666667%}.pull-lg-9{right:75%}.pull-lg-10{right:83.333333%}.pull-lg-11{right:91.666667%}.pull-lg-12{right:100%}.push-lg-0{left:auto}.push-lg-1{left:8.333333%}.push-lg-2{left:16.666667%}.push-lg-3{left:25%}.push-lg-4{left:33.333333%}.push-lg-5{left:41.666667%}.push-lg-6{left:50%}.push-lg-7{left:58.333333%}.push-lg-8{left:66.666667%}.push-lg-9{left:75%}.push-lg-10{left:83.333333%}.push-lg-11{left:91.666667%}.push-lg-12{left:100%}.offset-lg-0{margin-left:0%}.offset-lg-1{margin-left:8.333333%}.offset-lg-2{margin-left:16.666667%}.offset-lg-3{margin-left:25%}.offset-lg-4{margin-left:33.333333%}.offset-lg-5{margin-left:41.666667%}.offset-lg-6{margin-left:50%}.offset-lg-7{margin-left:58.333333%}.offset-lg-8{margin-left:66.666667%}.offset-lg-9{margin-left:75%}.offset-lg-10{margin-left:83.333333%}.offset-lg-11{margin-left:91.666667%}}@media (min-width:1200px){.col-xl-1{float:left;width:8.333333%}.col-xl-2{float:left;width:16.666667%}.col-xl-3{float:left;width:25%}.col-xl-4{float:left;width:33.333333%}.col-xl-5{float:left;width:41.666667%}.col-xl-6{float:left;width:50%}.col-xl-7{float:left;width:58.333333%}.col-xl-8{float:left;width:66.666667%}.col-xl-9{float:left;width:75%}.col-xl-10{float:left;width:83.333333%}.col-xl-11{float:left;width:91.666667%}.col-xl-12{float:left;width:100%}.pull-xl-0{right:auto}.pull-xl-1{right:8.333333%}.pull-xl-2{right:16.666667%}.pull-xl-3{right:25%}.pull-xl-4{right:33.333333%}.pull-xl-5{right:41.666667%}.pull-xl-6{right:50%}.pull-xl-7{right:58.333333%}.pull-xl-8{right:66.666667%}.pull-xl-9{right:75%}.pull-xl-10{right:83.333333%}.pull-xl-11{right:91.666667%}.pull-xl-12{right:100%}.push-xl-0{left:auto}.push-xl-1{left:8.333333%}.push-xl-2{left:16.666667%}.push-xl-3{left:25%}.push-xl-4{left:33.333333%}.push-xl-5{left:41.666667%}.push-xl-6{left:50%}.push-xl-7{left:58.333333%}.push-xl-8{left:66.666667%}.push-xl-9{left:75%}.push-xl-10{left:83.333333%}.push-xl-11{left:91.666667%}.push-xl-12{left:100%}.offset-xl-0{margin-left:0%}.offset-xl-1{margin-left:8.333333%}.offset-xl-2{margin-left:16.666667%}.offset-xl-3{margin-left:25%}.offset-xl-4{margin-left:33.333333%}.offset-xl-5{margin-left:41.666667%}.offset-xl-6{margin-left:50%}.offset-xl-7{margin-left:58.333333%}.offset-xl-8{margin-left:66.666667%}.offset-xl-9{margin-left:75%}.offset-xl-10{margin-left:83.333333%}.offset-xl-11{margin-left:91.666667%}}.table{width:100%;max-width:100%;margin-bottom:1rem}.table td,.table th{padding:.75rem;vertical-align:top;border-top:1px solid #eceeef}.table thead th{vertical-align:bottom;border-bottom:2px solid #eceeef}.table tbody+tbody{border-top:2px solid #eceeef}.table .table{background-color:#fff}.table-sm td,.table-sm th{padding:.3rem}.table-bordered{border:1px solid #eceeef}.table-bordered td,.table-bordered th{border:1px solid #eceeef}.table-bordered thead td,.table-bordered thead th{border-bottom-width:2px}.table-striped tbody tr:nth-of-type(odd){background-color:rgba(0,0,0,.05)}.table-hover tbody tr:hover{background-color:rgba(0,0,0,.075)}.table-active,.table-active>td,.table-active>th{background-color:rgba(0,0,0,.075)}.table-hover .table-active:hover{background-color:rgba(0,0,0,.075)}.table-hover .table-active:hover>td,.table-hover .table-active:hover>th{background-color:rgba(0,0,0,.075)}.table-success,.table-success>td,.table-success>th{background-color:#dff0d8}.table-hover .table-success:hover{background-color:#d0e9c6}.table-hover .table-success:hover>td,.table-hover .table-success:hover>th{background-color:#d0e9c6}.table-info,.table-info>td,.table-info>th{background-color:#d9edf7}.table-hover .table-info:hover{background-color:#c4e3f3}.table-hover .table-info:hover>td,.table-hover .table-info:hover>th{background-color:#c4e3f3}.table-warning,.table-warning>td,.table-warning>th{background-color:#fcf8e3}.table-hover .table-warning:hover{background-color:#faf2cc}.table-hover .table-warning:hover>td,.table-hover .table-warning:hover>th{background-color:#faf2cc}.table-danger,.table-danger>td,.table-danger>th{background-color:#f2dede}.table-hover .table-danger:hover{background-color:#ebcccc}.table-hover .table-danger:hover>td,.table-hover .table-danger:hover>th{background-color:#ebcccc}.thead-inverse th{color:#fff;background-color:#373a3c}.thead-default th{color:#55595c;background-color:#eceeef}.table-inverse{color:#eceeef;background-color:#373a3c}.table-inverse td,.table-inverse th,.table-inverse thead th{border-color:#55595c}.table-inverse.table-bordered{border:0}.table-responsive{display:block;width:100%;min-height:0%;overflow-x:auto}.table-reflow thead{float:left}.table-reflow tbody{display:block;white-space:nowrap}.table-reflow td,.table-reflow th{border-top:1px solid #eceeef;border-left:1px solid #eceeef}.table-reflow td:last-child,.table-reflow th:last-child{border-right:1px solid #eceeef}.table-reflow tbody:last-child tr:last-child td,.table-reflow tbody:last-child tr:last-child th,.table-reflow tfoot:last-child tr:last-child td,.table-reflow tfoot:last-child tr:last-child th,.table-reflow thead:last-child tr:last-child td,.table-reflow thead:last-child tr:last-child th{border-bottom:1px solid #eceeef}.table-reflow tr{float:left}.table-reflow tr td,.table-reflow tr th{display:block!important;border:1px solid #eceeef}.form-control{display:block;width:100%;padding:.5rem .75rem;font-size:1rem;line-height:1.25;color:#55595c;background-color:#fff;background-image:none;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid rgba(0,0,0,.15);border-radius:.25rem}.form-control::-ms-expand{background-color:transparent;border:0}.form-control:focus{color:#55595c;background-color:#fff;border-color:#66afe9;outline:0}.form-control::-webkit-input-placeholder{color:#999;opacity:1}.form-control::-moz-placeholder{color:#999;opacity:1}.form-control:-ms-input-placeholder{color:#999;opacity:1}.form-control::placeholder{color:#999;opacity:1}.form-control:disabled,.form-control[readonly]{background-color:#eceeef;opacity:1}.form-control:disabled{cursor:not-allowed}select.form-control:not([size]):not([multiple]){height:calc(2.5rem - 2px)}select.form-control:focus::-ms-value{color:#55595c;background-color:#fff}.form-control-file,.form-control-range{display:block}.col-form-label{padding-top:.5rem;padding-bottom:.5rem;margin-bottom:0}.col-form-label-lg{padding-top:.75rem;padding-bottom:.75rem;font-size:1.25rem}.col-form-label-sm{padding-top:.25rem;padding-bottom:.25rem;font-size:.875rem}.col-form-legend{padding-top:.5rem;padding-bottom:.5rem;margin-bottom:0;font-size:1rem}.form-control-static{padding-top:.5rem;padding-bottom:.5rem;line-height:1.25;border:solid transparent;border-width:1px 0}.form-control-static.form-control-lg,.form-control-static.form-control-sm,.input-group-lg>.form-control-static.form-control,.input-group-lg>.form-control-static.input-group-addon,.input-group-lg>.input-group-btn>.form-control-static.btn,.input-group-sm>.form-control-static.form-control,.input-group-sm>.form-control-static.input-group-addon,.input-group-sm>.input-group-btn>.form-control-static.btn{padding-right:0;padding-left:0}.form-control-sm,.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{padding:.25rem .5rem;font-size:.875rem;border-radius:.2rem}.input-group-sm>.input-group-btn>select.btn:not([size]):not([multiple]),.input-group-sm>select.form-control:not([size]):not([multiple]),.input-group-sm>select.input-group-addon:not([size]):not([multiple]),select.form-control-sm:not([size]):not([multiple]){height:1.8125rem}.form-control-lg,.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{padding:.75rem 1.5rem;font-size:1.25rem;border-radius:.3rem}.input-group-lg>.input-group-btn>select.btn:not([size]):not([multiple]),.input-group-lg>select.form-control:not([size]):not([multiple]),.input-group-lg>select.input-group-addon:not([size]):not([multiple]),select.form-control-lg:not([size]):not([multiple]){height:3.166667rem}.form-group{margin-bottom:1rem}.form-text{display:block;margin-top:.25rem}.form-check{position:relative;display:block;margin-bottom:.75rem}.form-check+.form-check{margin-top:-.25rem}.form-check.disabled .form-check-label{color:#818a91;cursor:not-allowed}.form-check-label{padding-left:1.25rem;margin-bottom:0;cursor:pointer}.form-check-input{position:absolute;margin-top:.25rem;margin-left:-1.25rem}.form-check-input:only-child{position:static}.form-check-inline{position:relative;display:inline-block;padding-left:1.25rem;margin-bottom:0;vertical-align:middle;cursor:pointer}.form-check-inline+.form-check-inline{margin-left:.75rem}.form-check-inline.disabled{color:#818a91;cursor:not-allowed}.form-control-feedback{margin-top:.25rem}.form-control-danger,.form-control-success,.form-control-warning{padding-right:2.25rem;background-repeat:no-repeat;background-position:center right .625rem;-webkit-background-size:1.25rem 1.25rem;background-size:1.25rem 1.25rem}.has-success .custom-control,.has-success .form-check-inline,.has-success .form-check-label,.has-success .form-control-feedback,.has-success .form-control-label{color:#5cb85c}.has-success .form-control{border-color:#5cb85c}.has-success .form-control:focus{-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #a3d7a3;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #a3d7a3}.has-success .input-group-addon{color:#5cb85c;border-color:#5cb85c;background-color:#eaf6ea}.has-success .form-control-success{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'%3E%3Cpath fill='#5cb85c' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3E%3C/svg%3E")}.has-warning .custom-control,.has-warning .form-check-inline,.has-warning .form-check-label,.has-warning .form-control-feedback,.has-warning .form-control-label{color:#f0ad4e}.has-warning .form-control{border-color:#f0ad4e}.has-warning .form-control:focus{-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #f8d9ac;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #f8d9ac}.has-warning .input-group-addon{color:#f0ad4e;border-color:#f0ad4e;background-color:#fff}.has-warning .form-control-warning{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'%3E%3Cpath fill='#f0ad4e' d='M4.4 5.324h-.8v-2.46h.8zm0 1.42h-.8V5.89h.8zM3.76.63L.04 7.075c-.115.2.016.425.26.426h7.397c.242 0 .372-.226.258-.426C6.726 4.924 5.47 2.79 4.253.63c-.113-.174-.39-.174-.494 0z'/%3E%3C/svg%3E")}.has-danger .custom-control,.has-danger .form-check-inline,.has-danger .form-check-label,.has-danger .form-control-feedback,.has-danger .form-control-label{color:#d9534f}.has-danger .form-control{border-color:#d9534f}.has-danger .form-control:focus{-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #eba5a3;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #eba5a3}.has-danger .input-group-addon{color:#d9534f;border-color:#d9534f;background-color:#fdf7f7}.has-danger .form-control-danger{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='#d9534f' viewBox='-2 -2 7 7'%3E%3Cpath stroke='%23d9534f' d='M0 0l3 3m0-3L0 3'/%3E%3Ccircle r='.5'/%3E%3Ccircle cx='3' r='.5'/%3E%3Ccircle cy='3' r='.5'/%3E%3Ccircle cx='3' cy='3' r='.5'/%3E%3C/svg%3E")}@media (min-width:576px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;width:auto;vertical-align:middle}.form-inline .input-group .form-control,.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .form-control-label{margin-bottom:0;vertical-align:middle}.form-inline .form-check{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .form-check-label{padding-left:0}.form-inline .form-check-input{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.btn{display:inline-block;font-weight:400;line-height:1.25;text-align:center;white-space:nowrap;vertical-align:middle;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;border:1px solid transparent;padding:.5rem 1rem;font-size:1rem;border-radius:.25rem}.btn.active.focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn:active:focus,.btn:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn:focus,.btn:hover{text-decoration:none}.btn.focus{text-decoration:none}.btn.active,.btn:active{background-image:none;outline:0}.btn.disabled,.btn:disabled{cursor:not-allowed;opacity:.65}a.btn.disabled,fieldset[disabled] a.btn{pointer-events:none}.btn-primary{color:#fff;background-color:#0275d8;border-color:#0275d8}.btn-primary:hover{color:#fff;background-color:#025aa5;border-color:#01549b}.btn-primary.focus,.btn-primary:focus{color:#fff;background-color:#025aa5;border-color:#01549b}.btn-primary.active,.btn-primary:active,.open>.btn-primary.dropdown-toggle{color:#fff;background-color:#025aa5;border-color:#01549b;background-image:none}.btn-primary.active.focus,.btn-primary.active:focus,.btn-primary.active:hover,.btn-primary:active.focus,.btn-primary:active:focus,.btn-primary:active:hover,.open>.btn-primary.dropdown-toggle.focus,.open>.btn-primary.dropdown-toggle:focus,.open>.btn-primary.dropdown-toggle:hover{color:#fff;background-color:#014682;border-color:#01315a}.btn-primary.disabled.focus,.btn-primary.disabled:focus,.btn-primary:disabled.focus,.btn-primary:disabled:focus{background-color:#0275d8;border-color:#0275d8}.btn-primary.disabled:hover,.btn-primary:disabled:hover{background-color:#0275d8;border-color:#0275d8}.btn-secondary{color:#373a3c;background-color:#fff;border-color:#ccc}.btn-secondary:hover{color:#373a3c;background-color:#e6e6e6;border-color:#adadad}.btn-secondary.focus,.btn-secondary:focus{color:#373a3c;background-color:#e6e6e6;border-color:#adadad}.btn-secondary.active,.btn-secondary:active,.open>.btn-secondary.dropdown-toggle{color:#373a3c;background-color:#e6e6e6;border-color:#adadad;background-image:none}.btn-secondary.active.focus,.btn-secondary.active:focus,.btn-secondary.active:hover,.btn-secondary:active.focus,.btn-secondary:active:focus,.btn-secondary:active:hover,.open>.btn-secondary.dropdown-toggle.focus,.open>.btn-secondary.dropdown-toggle:focus,.open>.btn-secondary.dropdown-toggle:hover{color:#373a3c;background-color:#d4d4d4;border-color:#8c8c8c}.btn-secondary.disabled.focus,.btn-secondary.disabled:focus,.btn-secondary:disabled.focus,.btn-secondary:disabled:focus{background-color:#fff;border-color:#ccc}.btn-secondary.disabled:hover,.btn-secondary:disabled:hover{background-color:#fff;border-color:#ccc}.btn-info{color:#fff;background-color:#5bc0de;border-color:#5bc0de}.btn-info:hover{color:#fff;background-color:#31b0d5;border-color:#2aabd2}.btn-info.focus,.btn-info:focus{color:#fff;background-color:#31b0d5;border-color:#2aabd2}.btn-info.active,.btn-info:active,.open>.btn-info.dropdown-toggle{color:#fff;background-color:#31b0d5;border-color:#2aabd2;background-image:none}.btn-info.active.focus,.btn-info.active:focus,.btn-info.active:hover,.btn-info:active.focus,.btn-info:active:focus,.btn-info:active:hover,.open>.btn-info.dropdown-toggle.focus,.open>.btn-info.dropdown-toggle:focus,.open>.btn-info.dropdown-toggle:hover{color:#fff;background-color:#269abc;border-color:#1f7e9a}.btn-info.disabled.focus,.btn-info.disabled:focus,.btn-info:disabled.focus,.btn-info:disabled:focus{background-color:#5bc0de;border-color:#5bc0de}.btn-info.disabled:hover,.btn-info:disabled:hover{background-color:#5bc0de;border-color:#5bc0de}.btn-success{color:#fff;background-color:#5cb85c;border-color:#5cb85c}.btn-success:hover{color:#fff;background-color:#449d44;border-color:#419641}.btn-success.focus,.btn-success:focus{color:#fff;background-color:#449d44;border-color:#419641}.btn-success.active,.btn-success:active,.open>.btn-success.dropdown-toggle{color:#fff;background-color:#449d44;border-color:#419641;background-image:none}.btn-success.active.focus,.btn-success.active:focus,.btn-success.active:hover,.btn-success:active.focus,.btn-success:active:focus,.btn-success:active:hover,.open>.btn-success.dropdown-toggle.focus,.open>.btn-success.dropdown-toggle:focus,.open>.btn-success.dropdown-toggle:hover{color:#fff;background-color:#398439;border-color:#2d672d}.btn-success.disabled.focus,.btn-success.disabled:focus,.btn-success:disabled.focus,.btn-success:disabled:focus{background-color:#5cb85c;border-color:#5cb85c}.btn-success.disabled:hover,.btn-success:disabled:hover{background-color:#5cb85c;border-color:#5cb85c}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#f0ad4e}.btn-warning:hover{color:#fff;background-color:#ec971f;border-color:#eb9316}.btn-warning.focus,.btn-warning:focus{color:#fff;background-color:#ec971f;border-color:#eb9316}.btn-warning.active,.btn-warning:active,.open>.btn-warning.dropdown-toggle{color:#fff;background-color:#ec971f;border-color:#eb9316;background-image:none}.btn-warning.active.focus,.btn-warning.active:focus,.btn-warning.active:hover,.btn-warning:active.focus,.btn-warning:active:focus,.btn-warning:active:hover,.open>.btn-warning.dropdown-toggle.focus,.open>.btn-warning.dropdown-toggle:focus,.open>.btn-warning.dropdown-toggle:hover{color:#fff;background-color:#d58512;border-color:#b06d0f}.btn-warning.disabled.focus,.btn-warning.disabled:focus,.btn-warning:disabled.focus,.btn-warning:disabled:focus{background-color:#f0ad4e;border-color:#f0ad4e}.btn-warning.disabled:hover,.btn-warning:disabled:hover{background-color:#f0ad4e;border-color:#f0ad4e}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d9534f}.btn-danger:hover{color:#fff;background-color:#c9302c;border-color:#c12e2a}.btn-danger.focus,.btn-danger:focus{color:#fff;background-color:#c9302c;border-color:#c12e2a}.btn-danger.active,.btn-danger:active,.open>.btn-danger.dropdown-toggle{color:#fff;background-color:#c9302c;border-color:#c12e2a;background-image:none}.btn-danger.active.focus,.btn-danger.active:focus,.btn-danger.active:hover,.btn-danger:active.focus,.btn-danger:active:focus,.btn-danger:active:hover,.open>.btn-danger.dropdown-toggle.focus,.open>.btn-danger.dropdown-toggle:focus,.open>.btn-danger.dropdown-toggle:hover{color:#fff;background-color:#ac2925;border-color:#8b211e}.btn-danger.disabled.focus,.btn-danger.disabled:focus,.btn-danger:disabled.focus,.btn-danger:disabled:focus{background-color:#d9534f;border-color:#d9534f}.btn-danger.disabled:hover,.btn-danger:disabled:hover{background-color:#d9534f;border-color:#d9534f}.btn-outline-primary{color:#0275d8;background-image:none;background-color:transparent;border-color:#0275d8}.btn-outline-primary:hover{color:#fff;background-color:#0275d8;border-color:#0275d8}.btn-outline-primary.focus,.btn-outline-primary:focus{color:#fff;background-color:#0275d8;border-color:#0275d8}.btn-outline-primary.active,.btn-outline-primary:active,.open>.btn-outline-primary.dropdown-toggle{color:#fff;background-color:#0275d8;border-color:#0275d8}.btn-outline-primary.active.focus,.btn-outline-primary.active:focus,.btn-outline-primary.active:hover,.btn-outline-primary:active.focus,.btn-outline-primary:active:focus,.btn-outline-primary:active:hover,.open>.btn-outline-primary.dropdown-toggle.focus,.open>.btn-outline-primary.dropdown-toggle:focus,.open>.btn-outline-primary.dropdown-toggle:hover{color:#fff;background-color:#014682;border-color:#01315a}.btn-outline-primary.disabled.focus,.btn-outline-primary.disabled:focus,.btn-outline-primary:disabled.focus,.btn-outline-primary:disabled:focus{border-color:#43a7fd}.btn-outline-primary.disabled:hover,.btn-outline-primary:disabled:hover{border-color:#43a7fd}.btn-outline-secondary{color:#ccc;background-image:none;background-color:transparent;border-color:#ccc}.btn-outline-secondary:hover{color:#fff;background-color:#ccc;border-color:#ccc}.btn-outline-secondary.focus,.btn-outline-secondary:focus{color:#fff;background-color:#ccc;border-color:#ccc}.btn-outline-secondary.active,.btn-outline-secondary:active,.open>.btn-outline-secondary.dropdown-toggle{color:#fff;background-color:#ccc;border-color:#ccc}.btn-outline-secondary.active.focus,.btn-outline-secondary.active:focus,.btn-outline-secondary.active:hover,.btn-outline-secondary:active.focus,.btn-outline-secondary:active:focus,.btn-outline-secondary:active:hover,.open>.btn-outline-secondary.dropdown-toggle.focus,.open>.btn-outline-secondary.dropdown-toggle:focus,.open>.btn-outline-secondary.dropdown-toggle:hover{color:#fff;background-color:#a1a1a1;border-color:#8c8c8c}.btn-outline-secondary.disabled.focus,.btn-outline-secondary.disabled:focus,.btn-outline-secondary:disabled.focus,.btn-outline-secondary:disabled:focus{border-color:#fff}.btn-outline-secondary.disabled:hover,.btn-outline-secondary:disabled:hover{border-color:#fff}.btn-outline-info{color:#5bc0de;background-image:none;background-color:transparent;border-color:#5bc0de}.btn-outline-info:hover{color:#fff;background-color:#5bc0de;border-color:#5bc0de}.btn-outline-info.focus,.btn-outline-info:focus{color:#fff;background-color:#5bc0de;border-color:#5bc0de}.btn-outline-info.active,.btn-outline-info:active,.open>.btn-outline-info.dropdown-toggle{color:#fff;background-color:#5bc0de;border-color:#5bc0de}.btn-outline-info.active.focus,.btn-outline-info.active:focus,.btn-outline-info.active:hover,.btn-outline-info:active.focus,.btn-outline-info:active:focus,.btn-outline-info:active:hover,.open>.btn-outline-info.dropdown-toggle.focus,.open>.btn-outline-info.dropdown-toggle:focus,.open>.btn-outline-info.dropdown-toggle:hover{color:#fff;background-color:#269abc;border-color:#1f7e9a}.btn-outline-info.disabled.focus,.btn-outline-info.disabled:focus,.btn-outline-info:disabled.focus,.btn-outline-info:disabled:focus{border-color:#b0e1ef}.btn-outline-info.disabled:hover,.btn-outline-info:disabled:hover{border-color:#b0e1ef}.btn-outline-success{color:#5cb85c;background-image:none;background-color:transparent;border-color:#5cb85c}.btn-outline-success:hover{color:#fff;background-color:#5cb85c;border-color:#5cb85c}.btn-outline-success.focus,.btn-outline-success:focus{color:#fff;background-color:#5cb85c;border-color:#5cb85c}.btn-outline-success.active,.btn-outline-success:active,.open>.btn-outline-success.dropdown-toggle{color:#fff;background-color:#5cb85c;border-color:#5cb85c}.btn-outline-success.active.focus,.btn-outline-success.active:focus,.btn-outline-success.active:hover,.btn-outline-success:active.focus,.btn-outline-success:active:focus,.btn-outline-success:active:hover,.open>.btn-outline-success.dropdown-toggle.focus,.open>.btn-outline-success.dropdown-toggle:focus,.open>.btn-outline-success.dropdown-toggle:hover{color:#fff;background-color:#398439;border-color:#2d672d}.btn-outline-success.disabled.focus,.btn-outline-success.disabled:focus,.btn-outline-success:disabled.focus,.btn-outline-success:disabled:focus{border-color:#a3d7a3}.btn-outline-success.disabled:hover,.btn-outline-success:disabled:hover{border-color:#a3d7a3}.btn-outline-warning{color:#f0ad4e;background-image:none;background-color:transparent;border-color:#f0ad4e}.btn-outline-warning:hover{color:#fff;background-color:#f0ad4e;border-color:#f0ad4e}.btn-outline-warning.focus,.btn-outline-warning:focus{color:#fff;background-color:#f0ad4e;border-color:#f0ad4e}.btn-outline-warning.active,.btn-outline-warning:active,.open>.btn-outline-warning.dropdown-toggle{color:#fff;background-color:#f0ad4e;border-color:#f0ad4e}.btn-outline-warning.active.focus,.btn-outline-warning.active:focus,.btn-outline-warning.active:hover,.btn-outline-warning:active.focus,.btn-outline-warning:active:focus,.btn-outline-warning:active:hover,.open>.btn-outline-warning.dropdown-toggle.focus,.open>.btn-outline-warning.dropdown-toggle:focus,.open>.btn-outline-warning.dropdown-toggle:hover{color:#fff;background-color:#d58512;border-color:#b06d0f}.btn-outline-warning.disabled.focus,.btn-outline-warning.disabled:focus,.btn-outline-warning:disabled.focus,.btn-outline-warning:disabled:focus{border-color:#f8d9ac}.btn-outline-warning.disabled:hover,.btn-outline-warning:disabled:hover{border-color:#f8d9ac}.btn-outline-danger{color:#d9534f;background-image:none;background-color:transparent;border-color:#d9534f}.btn-outline-danger:hover{color:#fff;background-color:#d9534f;border-color:#d9534f}.btn-outline-danger.focus,.btn-outline-danger:focus{color:#fff;background-color:#d9534f;border-color:#d9534f}.btn-outline-danger.active,.btn-outline-danger:active,.open>.btn-outline-danger.dropdown-toggle{color:#fff;background-color:#d9534f;border-color:#d9534f}.btn-outline-danger.active.focus,.btn-outline-danger.active:focus,.btn-outline-danger.active:hover,.btn-outline-danger:active.focus,.btn-outline-danger:active:focus,.btn-outline-danger:active:hover,.open>.btn-outline-danger.dropdown-toggle.focus,.open>.btn-outline-danger.dropdown-toggle:focus,.open>.btn-outline-danger.dropdown-toggle:hover{color:#fff;background-color:#ac2925;border-color:#8b211e}.btn-outline-danger.disabled.focus,.btn-outline-danger.disabled:focus,.btn-outline-danger:disabled.focus,.btn-outline-danger:disabled:focus{border-color:#eba5a3}.btn-outline-danger.disabled:hover,.btn-outline-danger:disabled:hover{border-color:#eba5a3}.btn-link{font-weight:400;color:#0275d8;border-radius:0}.btn-link,.btn-link.active,.btn-link:active,.btn-link:disabled{background-color:transparent}.btn-link,.btn-link:active,.btn-link:focus{border-color:transparent}.btn-link:hover{border-color:transparent}.btn-link:focus,.btn-link:hover{color:#014c8c;text-decoration:underline;background-color:transparent}.btn-link:disabled:focus,.btn-link:disabled:hover{color:#818a91;text-decoration:none}.btn-group-lg>.btn,.btn-lg{padding:.75rem 1.5rem;font-size:1.25rem;border-radius:.3rem}.btn-group-sm>.btn,.btn-sm{padding:.25rem .5rem;font-size:.875rem;border-radius:.2rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input[type=button].btn-block,input[type=reset].btn-block,input[type=submit].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease;-webkit-transition-duration:.35s;-o-transition-duration:.35s;transition-duration:.35s;-webkit-transition-property:height;-o-transition-property:height;transition-property:height}.dropdown,.dropup{position:relative}.dropdown-toggle::after{display:inline-block;width:0;height:0;margin-left:.3em;vertical-align:middle;content:"";border-top:.3em solid;border-right:.3em solid transparent;border-left:.3em solid transparent}.dropdown-toggle:focus{outline:0}.dropup .dropdown-toggle::after{border-top:0;border-bottom:.3em solid}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:10rem;padding:.5rem 0;margin:.125rem 0 0;font-size:1rem;color:#373a3c;text-align:left;list-style:none;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid rgba(0,0,0,.15);border-radius:.25rem}.dropdown-divider{height:1px;margin:.5rem 0;overflow:hidden;background-color:#e5e5e5}.dropdown-item{display:block;width:100%;padding:3px 1.5rem;clear:both;font-weight:400;color:#373a3c;text-align:inherit;white-space:nowrap;background:0 0;border:0}.dropdown-item:focus,.dropdown-item:hover{color:#2b2d2f;text-decoration:none;background-color:#f5f5f5}.dropdown-item.active,.dropdown-item.active:focus,.dropdown-item.active:hover{color:#fff;text-decoration:none;background-color:#0275d8;outline:0}.dropdown-item.disabled,.dropdown-item.disabled:focus,.dropdown-item.disabled:hover{color:#818a91}.dropdown-item.disabled:focus,.dropdown-item.disabled:hover{text-decoration:none;cursor:not-allowed;background-color:transparent;background-image:none;filter:"progid:DXImageTransform.Microsoft.gradient(enabled = false)"}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{right:0;left:auto}.dropdown-menu-left{right:auto;left:0}.dropdown-header{display:block;padding:.5rem 1.5rem;margin-bottom:0;font-size:.875rem;color:#818a91;white-space:nowrap}.dropdown-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:990}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{content:"";border-top:0;border-bottom:.3em solid}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:.125rem}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group-vertical>.btn,.btn-group>.btn{position:relative;float:left;margin-bottom:0}.btn-group-vertical>.btn.active,.btn-group-vertical>.btn:active,.btn-group-vertical>.btn:focus,.btn-group>.btn.active,.btn-group>.btn:active,.btn-group>.btn:focus{z-index:2}.btn-group-vertical>.btn:hover,.btn-group>.btn:hover{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-.5rem}.btn-toolbar::after{content:"";display:table;clear:both}.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:.5rem}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-bottom-right-radius:0;border-top-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-top-right-radius:0}.btn-group>.btn-group:last-child:not(:first-child)>.btn:first-child{border-bottom-left-radius:0;border-top-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn+.dropdown-toggle-split{padding-right:.75rem;padding-left:.75rem}.btn+.dropdown-toggle-split::after{margin-left:0}.btn-group-sm>.btn+.dropdown-toggle-split,.btn-sm+.dropdown-toggle-split{padding-right:.375rem;padding-left:.375rem}.btn-group-lg>.btn+.dropdown-toggle-split,.btn-lg+.dropdown-toggle-split{padding-right:1.125rem;padding-left:1.125rem}.btn .caret{margin-left:0}.btn-group-lg>.btn .caret,.btn-lg .caret{border-width:.3em .3em 0;border-bottom-width:0}.dropup .btn-group-lg>.btn .caret,.dropup .btn-lg .caret{border-width:0 .3em .3em}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group::after{content:"";display:table;clear:both}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-top-right-radius:0;border-top-left-radius:0}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-right-radius:0;border-top-left-radius:0}[data-toggle=buttons]>.btn input[type=checkbox],[data-toggle=buttons]>.btn input[type=radio],[data-toggle=buttons]>.btn-group>.btn input[type=checkbox],[data-toggle=buttons]>.btn-group>.btn input[type=radio]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;width:100%;display:table;border-collapse:separate}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group .form-control:active,.input-group .form-control:focus,.input-group .form-control:hover{z-index:3}.input-group .form-control,.input-group-addon,.input-group-btn{display:table-cell}.input-group .form-control:not(:first-child):not(:last-child),.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:.5rem .75rem;margin-bottom:0;font-size:1rem;font-weight:400;line-height:1.25;color:#55595c;text-align:center;background-color:#eceeef;border:1px solid rgba(0,0,0,.15);border-radius:.25rem}.input-group-addon.form-control-sm,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.input-group-addon.btn{padding:.25rem .5rem;font-size:.875rem;border-radius:.2rem}.input-group-addon.form-control-lg,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.input-group-addon.btn{padding:.75rem 1.5rem;font-size:1.25rem;border-radius:.3rem}.input-group-addon input[type=checkbox],.input-group-addon input[type=radio]{margin-top:0}.input-group .form-control:not(:last-child),.input-group-addon:not(:last-child),.input-group-btn:not(:first-child)>.btn-group:not(:last-child)>.btn,.input-group-btn:not(:first-child)>.btn:not(:last-child):not(.dropdown-toggle),.input-group-btn:not(:last-child)>.btn,.input-group-btn:not(:last-child)>.btn-group>.btn,.input-group-btn:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-top-right-radius:0}.input-group-addon:not(:last-child){border-right:0}.input-group .form-control:not(:first-child),.input-group-addon:not(:first-child),.input-group-btn:not(:first-child)>.btn,.input-group-btn:not(:first-child)>.btn-group>.btn,.input-group-btn:not(:first-child)>.dropdown-toggle,.input-group-btn:not(:last-child)>.btn-group:not(:first-child)>.btn,.input-group-btn:not(:last-child)>.btn:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.form-control+.input-group-addon:not(:first-child){border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:active,.input-group-btn>.btn:focus,.input-group-btn>.btn:hover{z-index:3}.input-group-btn:not(:last-child)>.btn,.input-group-btn:not(:last-child)>.btn-group{margin-right:-1px}.input-group-btn:not(:first-child)>.btn,.input-group-btn:not(:first-child)>.btn-group{z-index:2;margin-left:-1px}.input-group-btn:not(:first-child)>.btn-group:active,.input-group-btn:not(:first-child)>.btn-group:focus,.input-group-btn:not(:first-child)>.btn-group:hover,.input-group-btn:not(:first-child)>.btn:active,.input-group-btn:not(:first-child)>.btn:focus,.input-group-btn:not(:first-child)>.btn:hover{z-index:3}.custom-control{position:relative;display:inline-block;padding-left:1.5rem;cursor:pointer}.custom-control+.custom-control{margin-left:1rem}.custom-control-input{position:absolute;z-index:-1;opacity:0}.custom-control-input:checked~.custom-control-indicator{color:#fff;background-color:#0074d9}.custom-control-input:focus~.custom-control-indicator{-webkit-box-shadow:0 0 0 .075rem #fff,0 0 0 .2rem #0074d9;box-shadow:0 0 0 .075rem #fff,0 0 0 .2rem #0074d9}.custom-control-input:active~.custom-control-indicator{color:#fff;background-color:#84c6ff}.custom-control-input:disabled~.custom-control-indicator{cursor:not-allowed;background-color:#eee}.custom-control-input:disabled~.custom-control-description{color:#767676;cursor:not-allowed}.custom-control-indicator{position:absolute;top:.25rem;left:0;display:block;width:1rem;height:1rem;pointer-events:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:#ddd;background-repeat:no-repeat;background-position:center center;-webkit-background-size:50% 50%;background-size:50% 50%}.custom-checkbox .custom-control-indicator{border-radius:.25rem}.custom-checkbox .custom-control-input:checked~.custom-control-indicator{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'%3E%3Cpath fill='#fff' d='M6.564.75l-3.59 3.612-1.538-1.55L0 4.26 2.974 7.25 8 2.193z'/%3E%3C/svg%3E")}.custom-checkbox .custom-control-input:indeterminate~.custom-control-indicator{background-color:#0074d9;background-image:url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 4'%3E%3Cpath stroke='#fff' d='M0 2h4'/%3E%3C/svg%3E")}.custom-radio .custom-control-indicator{border-radius:50%}.custom-radio .custom-control-input:checked~.custom-control-indicator{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'%3E%3Ccircle r='3' fill='#fff'/%3E%3C/svg%3E")}.custom-controls-stacked .custom-control{float:left;clear:left}.custom-controls-stacked .custom-control+.custom-control{margin-left:0}.custom-select{display:inline-block;max-width:100%;height:calc(2.5rem - 2px);padding:.375rem 1.75rem .375rem .75rem;padding-right:.75rem\9;color:#55595c;vertical-align:middle;background:#fff url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='#333' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right .75rem center;background-image:none\9;-webkit-background-size:8px 10px;background-size:8px 10px;border:1px solid rgba(0,0,0,.15);border-radius:.25rem;-moz-appearance:none;-webkit-appearance:none}.custom-select:focus{border-color:#51a7e8;outline:0}.custom-select:focus::-ms-value{color:#55595c;background-color:#fff}.custom-select:disabled{color:#818a91;cursor:not-allowed;background-color:#eceeef}.custom-select::-ms-expand{opacity:0}.custom-select-sm{padding-top:.375rem;padding-bottom:.375rem;font-size:75%}.custom-file{position:relative;display:inline-block;max-width:100%;height:2.5rem;cursor:pointer}.custom-file-input{min-width:14rem;max-width:100%;margin:0;filter:alpha(opacity=0);opacity:0}.custom-file-control{position:absolute;top:0;right:0;left:0;z-index:5;height:2.5rem;padding:.5rem 1rem;line-height:1.5;color:#555;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:#fff;border:1px solid #ddd;border-radius:.25rem}.custom-file-control:lang(en)::after{content:"Choose file..."}.custom-file-control::before{position:absolute;top:-1px;right:-1px;bottom:-1px;z-index:6;display:block;height:2.5rem;padding:.5rem 1rem;line-height:1.5;color:#555;background-color:#eee;border:1px solid #ddd;border-radius:0 .25rem .25rem 0}.custom-file-control:lang(en)::before{content:"Browse"}.nav{padding-left:0;margin-bottom:0;list-style:none}.nav-link{display:inline-block}.nav-link:focus,.nav-link:hover{text-decoration:none}.nav-link.disabled{color:#818a91}.nav-link.disabled,.nav-link.disabled:focus,.nav-link.disabled:hover{color:#818a91;cursor:not-allowed;background-color:transparent}.nav-inline .nav-item{display:inline-block}.nav-inline .nav-item+.nav-item,.nav-inline .nav-link+.nav-link{margin-left:1rem}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs::after{content:"";display:table;clear:both}.nav-tabs .nav-item{float:left;margin-bottom:-1px}.nav-tabs .nav-item+.nav-item{margin-left:.2rem}.nav-tabs .nav-link{display:block;padding:.5em 1em;border:1px solid transparent;border-top-right-radius:.25rem;border-top-left-radius:.25rem}.nav-tabs .nav-link:focus,.nav-tabs .nav-link:hover{border-color:#eceeef #eceeef #ddd}.nav-tabs .nav-link.disabled,.nav-tabs .nav-link.disabled:focus,.nav-tabs .nav-link.disabled:hover{color:#818a91;background-color:transparent;border-color:transparent}.nav-tabs .nav-item.open .nav-link,.nav-tabs .nav-item.open .nav-link:focus,.nav-tabs .nav-item.open .nav-link:hover,.nav-tabs .nav-link.active,.nav-tabs .nav-link.active:focus,.nav-tabs .nav-link.active:hover{color:#55595c;background-color:#fff;border-color:#ddd #ddd transparent}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-right-radius:0;border-top-left-radius:0}.nav-pills::after{content:"";display:table;clear:both}.nav-pills .nav-item{float:left}.nav-pills .nav-item+.nav-item{margin-left:.2rem}.nav-pills .nav-link{display:block;padding:.5em 1em;border-radius:.25rem}.nav-pills .nav-item.open .nav-link,.nav-pills .nav-item.open .nav-link:focus,.nav-pills .nav-item.open .nav-link:hover,.nav-pills .nav-link.active,.nav-pills .nav-link.active:focus,.nav-pills .nav-link.active:hover{color:#fff;cursor:default;background-color:#0275d8}.nav-stacked .nav-item{display:block;float:none}.nav-stacked .nav-item+.nav-item{margin-top:.2rem;margin-left:0}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.navbar{position:relative;padding:.5rem 1rem}.navbar::after{content:"";display:table;clear:both}@media (min-width:576px){.navbar{border-radius:.25rem}}.navbar-full{z-index:1000}@media (min-width:576px){.navbar-full{border-radius:0}}.navbar-fixed-bottom,.navbar-fixed-top{position:fixed;right:0;left:0;z-index:1030}@media (min-width:576px){.navbar-fixed-bottom,.navbar-fixed-top{border-radius:0}}.navbar-fixed-top{top:0}.navbar-fixed-bottom{bottom:0}.navbar-sticky-top{position:-webkit-sticky;position:sticky;top:0;z-index:1030;width:100%}@media (min-width:576px){.navbar-sticky-top{border-radius:0}}.navbar-brand{float:left;padding-top:.25rem;padding-bottom:.25rem;margin-right:1rem;font-size:1.25rem;line-height:inherit}.navbar-brand:focus,.navbar-brand:hover{text-decoration:none}.navbar-divider{float:left;width:1px;padding-top:.425rem;padding-bottom:.425rem;margin-right:1rem;margin-left:1rem;overflow:hidden}.navbar-divider::before{content:"\00a0"}.navbar-text{display:inline-block;padding-top:.425rem;padding-bottom:.425rem}.navbar-toggler{width:2.5em;height:2em;padding:.5rem .75rem;font-size:1.25rem;line-height:1;background:transparent no-repeat center center;-webkit-background-size:24px 24px;background-size:24px 24px;border:1px solid transparent;border-radius:.25rem}.navbar-toggler:focus,.navbar-toggler:hover{text-decoration:none}.navbar-toggleable-xs::after{content:"";display:table;clear:both}@media (max-width:575px){.navbar-toggleable-xs .navbar-brand{display:block;float:none;margin-top:.5rem;margin-right:0}.navbar-toggleable-xs .navbar-nav{margin-top:.5rem;margin-bottom:.5rem}.navbar-toggleable-xs .navbar-nav .dropdown-menu{position:static;float:none}}@media (min-width:576px){.navbar-toggleable-xs{display:block}}.navbar-toggleable-sm::after{content:"";display:table;clear:both}@media (max-width:767px){.navbar-toggleable-sm .navbar-brand{display:block;float:none;margin-top:.5rem;margin-right:0}.navbar-toggleable-sm .navbar-nav{margin-top:.5rem;margin-bottom:.5rem}.navbar-toggleable-sm .navbar-nav .dropdown-menu{position:static;float:none}}@media (min-width:768px){.navbar-toggleable-sm{display:block}}.navbar-toggleable-md::after{content:"";display:table;clear:both}@media (max-width:991px){.navbar-toggleable-md .navbar-brand{display:block;float:none;margin-top:.5rem;margin-right:0}.navbar-toggleable-md .navbar-nav{margin-top:.5rem;margin-bottom:.5rem}.navbar-toggleable-md .navbar-nav .dropdown-menu{position:static;float:none}}@media (min-width:992px){.navbar-toggleable-md{display:block}}.navbar-toggleable-lg::after{content:"";display:table;clear:both}@media (max-width:1199px){.navbar-toggleable-lg .navbar-brand{display:block;float:none;margin-top:.5rem;margin-right:0}.navbar-toggleable-lg .navbar-nav{margin-top:.5rem;margin-bottom:.5rem}.navbar-toggleable-lg .navbar-nav .dropdown-menu{position:static;float:none}}@media (min-width:1200px){.navbar-toggleable-lg{display:block}}.navbar-toggleable-xl{display:block}.navbar-toggleable-xl::after{content:"";display:table;clear:both}.navbar-toggleable-xl .navbar-brand{display:block;float:none;margin-top:.5rem;margin-right:0}.navbar-toggleable-xl .navbar-nav{margin-top:.5rem;margin-bottom:.5rem}.navbar-toggleable-xl .navbar-nav .dropdown-menu{position:static;float:none}.navbar-nav .nav-item{float:left}.navbar-nav .nav-link{display:block;padding-top:.425rem;padding-bottom:.425rem}.navbar-nav .nav-link+.nav-link{margin-left:1rem}.navbar-nav .nav-item+.nav-item{margin-left:1rem}.navbar-light .navbar-brand,.navbar-light .navbar-toggler{color:rgba(0,0,0,.9)}.navbar-light .navbar-brand:focus,.navbar-light .navbar-brand:hover,.navbar-light .navbar-toggler:focus,.navbar-light .navbar-toggler:hover{color:rgba(0,0,0,.9)}.navbar-light .navbar-nav .nav-link{color:rgba(0,0,0,.5)}.navbar-light .navbar-nav .nav-link:focus,.navbar-light .navbar-nav .nav-link:hover{color:rgba(0,0,0,.7)}.navbar-light .navbar-nav .active>.nav-link,.navbar-light .navbar-nav .active>.nav-link:focus,.navbar-light .navbar-nav .active>.nav-link:hover,.navbar-light .navbar-nav .nav-link.active,.navbar-light .navbar-nav .nav-link.active:focus,.navbar-light .navbar-nav .nav-link.active:hover,.navbar-light .navbar-nav .nav-link.open,.navbar-light .navbar-nav .nav-link.open:focus,.navbar-light .navbar-nav .nav-link.open:hover,.navbar-light .navbar-nav .open>.nav-link,.navbar-light .navbar-nav .open>.nav-link:focus,.navbar-light .navbar-nav .open>.nav-link:hover{color:rgba(0,0,0,.9)}.navbar-light .navbar-toggler{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath stroke='rgba(0, 0, 0, 0.5)' stroke-width='2' stroke-linecap='round' stroke-miterlimit='10' d='M4 8h24M4 16h24M4 24h24'/%3E%3C/svg%3E");border-color:rgba(0,0,0,.1)}.navbar-light .navbar-divider{background-color:rgba(0,0,0,.075)}.navbar-dark .navbar-brand,.navbar-dark .navbar-toggler{color:#fff}.navbar-dark .navbar-brand:focus,.navbar-dark .navbar-brand:hover,.navbar-dark .navbar-toggler:focus,.navbar-dark .navbar-toggler:hover{color:#fff}.navbar-dark .navbar-nav .nav-link{color:rgba(255,255,255,.5)}.navbar-dark .navbar-nav .nav-link:focus,.navbar-dark .navbar-nav .nav-link:hover{color:rgba(255,255,255,.75)}.navbar-dark .navbar-nav .active>.nav-link,.navbar-dark .navbar-nav .active>.nav-link:focus,.navbar-dark .navbar-nav .active>.nav-link:hover,.navbar-dark .navbar-nav .nav-link.active,.navbar-dark .navbar-nav .nav-link.active:focus,.navbar-dark .navbar-nav .nav-link.active:hover,.navbar-dark .navbar-nav .nav-link.open,.navbar-dark .navbar-nav .nav-link.open:focus,.navbar-dark .navbar-nav .nav-link.open:hover,.navbar-dark .navbar-nav .open>.nav-link,.navbar-dark .navbar-nav .open>.nav-link:focus,.navbar-dark .navbar-nav .open>.nav-link:hover{color:#fff}.navbar-dark .navbar-toggler{background-image:url("data:image/svg+xml;charset=utf8,%3Csvg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath stroke='rgba(255, 255, 255, 0.5)' stroke-width='2' stroke-linecap='round' stroke-miterlimit='10' d='M4 8h24M4 16h24M4 24h24'/%3E%3C/svg%3E");border-color:rgba(255,255,255,.1)}.navbar-dark .navbar-divider{background-color:rgba(255,255,255,.075)}.navbar-toggleable-xs::after{content:"";display:table;clear:both}@media (max-width:575px){.navbar-toggleable-xs .navbar-nav .nav-item{float:none;margin-left:0}}@media (min-width:576px){.navbar-toggleable-xs{display:block!important}}.navbar-toggleable-sm::after{content:"";display:table;clear:both}@media (max-width:767px){.navbar-toggleable-sm .navbar-nav .nav-item{float:none;margin-left:0}}@media (min-width:768px){.navbar-toggleable-sm{display:block!important}}.navbar-toggleable-md::after{content:"";display:table;clear:both}@media (max-width:991px){.navbar-toggleable-md .navbar-nav .nav-item{float:none;margin-left:0}}@media (min-width:992px){.navbar-toggleable-md{display:block!important}}.card{position:relative;display:block;margin-bottom:.75rem;background-color:#fff;border-radius:.25rem;border:1px solid rgba(0,0,0,.125)}.card-block{padding:1.25rem}.card-block::after{content:"";display:table;clear:both}.card-title{margin-bottom:.75rem}.card-subtitle{margin-top:-.375rem;margin-bottom:0}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card>.list-group:first-child .list-group-item:first-child{border-top-right-radius:.25rem;border-top-left-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-right-radius:.25rem;border-bottom-left-radius:.25rem}.card-header{padding:.75rem 1.25rem;margin-bottom:0;background-color:#f5f5f5;border-bottom:1px solid rgba(0,0,0,.125)}.card-header::after{content:"";display:table;clear:both}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-footer{padding:.75rem 1.25rem;background-color:#f5f5f5;border-top:1px solid rgba(0,0,0,.125)}.card-footer::after{content:"";display:table;clear:both}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{margin-right:-.625rem;margin-bottom:-.75rem;margin-left:-.625rem;border-bottom:0}.card-header-pills{margin-right:-.625rem;margin-left:-.625rem}.card-primary{background-color:#0275d8;border-color:#0275d8}.card-primary .card-footer,.card-primary .card-header{background-color:transparent}.card-success{background-color:#5cb85c;border-color:#5cb85c}.card-success .card-footer,.card-success .card-header{background-color:transparent}.card-info{background-color:#5bc0de;border-color:#5bc0de}.card-info .card-footer,.card-info .card-header{background-color:transparent}.card-warning{background-color:#f0ad4e;border-color:#f0ad4e}.card-warning .card-footer,.card-warning .card-header{background-color:transparent}.card-danger{background-color:#d9534f;border-color:#d9534f}.card-danger .card-footer,.card-danger .card-header{background-color:transparent}.card-outline-primary{background-color:transparent;border-color:#0275d8}.card-outline-secondary{background-color:transparent;border-color:#ccc}.card-outline-info{background-color:transparent;border-color:#5bc0de}.card-outline-success{background-color:transparent;border-color:#5cb85c}.card-outline-warning{background-color:transparent;border-color:#f0ad4e}.card-outline-danger{background-color:transparent;border-color:#d9534f}.card-inverse .card-footer,.card-inverse .card-header{border-color:rgba(255,255,255,.2)}.card-inverse .card-blockquote,.card-inverse .card-footer,.card-inverse .card-header,.card-inverse .card-title{color:#fff}.card-inverse .card-blockquote .blockquote-footer,.card-inverse .card-link,.card-inverse .card-subtitle,.card-inverse .card-text{color:rgba(255,255,255,.65)}.card-inverse .card-link:focus,.card-inverse .card-link:hover{color:#fff}.card-blockquote{padding:0;margin-bottom:0;border-left:0}.card-img{border-radius:calc(.25rem - 1px)}.card-img-overlay{position:absolute;top:0;right:0;bottom:0;left:0;padding:1.25rem}.card-img-top{border-top-right-radius:calc(.25rem - 1px);border-top-left-radius:calc(.25rem - 1px)}.card-img-bottom{border-bottom-right-radius:calc(.25rem - 1px);border-bottom-left-radius:calc(.25rem - 1px)}@media (min-width:576px){.card-deck{display:table;width:100%;margin-bottom:.75rem;table-layout:fixed;border-spacing:1.25rem 0}.card-deck .card{display:table-cell;margin-bottom:0;vertical-align:top}.card-deck-wrapper{margin-right:-1.25rem;margin-left:-1.25rem}}@media (min-width:576px){.card-group{display:table;width:100%;table-layout:fixed}.card-group .card{display:table-cell;vertical-align:top}.card-group .card+.card{margin-left:0;border-left:0}.card-group .card:first-child{border-bottom-right-radius:0;border-top-right-radius:0}.card-group .card:first-child .card-img-top{border-top-right-radius:0}.card-group .card:first-child .card-img-bottom{border-bottom-right-radius:0}.card-group .card:last-child{border-bottom-left-radius:0;border-top-left-radius:0}.card-group .card:last-child .card-img-top{border-top-left-radius:0}.card-group .card:last-child .card-img-bottom{border-bottom-left-radius:0}.card-group .card:not(:first-child):not(:last-child){border-radius:0}.card-group .card:not(:first-child):not(:last-child) .card-img-bottom,.card-group .card:not(:first-child):not(:last-child) .card-img-top{border-radius:0}}@media (min-width:576px){.card-columns{-webkit-column-count:3;-moz-column-count:3;column-count:3;-webkit-column-gap:1.25rem;-moz-column-gap:1.25rem;column-gap:1.25rem}.card-columns .card{display:inline-block;width:100%}}.breadcrumb{padding:.75rem 1rem;margin-bottom:1rem;list-style:none;background-color:#eceeef;border-radius:.25rem}.breadcrumb::after{content:"";display:table;clear:both}.breadcrumb-item{float:left}.breadcrumb-item+.breadcrumb-item::before{display:inline-block;padding-right:.5rem;padding-left:.5rem;color:#818a91;content:"/"}.breadcrumb-item+.breadcrumb-item:hover::before{text-decoration:underline}.breadcrumb-item+.breadcrumb-item:hover::before{text-decoration:none}.breadcrumb-item.active{color:#818a91}.pagination{display:inline-block;padding-left:0;margin-top:1rem;margin-bottom:1rem;border-radius:.25rem}.page-item{display:inline}.page-item:first-child .page-link{margin-left:0;border-bottom-left-radius:.25rem;border-top-left-radius:.25rem}.page-item:last-child .page-link{border-bottom-right-radius:.25rem;border-top-right-radius:.25rem}.page-item.active .page-link,.page-item.active .page-link:focus,.page-item.active .page-link:hover{z-index:2;color:#fff;cursor:default;background-color:#0275d8;border-color:#0275d8}.page-item.disabled .page-link,.page-item.disabled .page-link:focus,.page-item.disabled .page-link:hover{color:#818a91;pointer-events:none;cursor:not-allowed;background-color:#fff;border-color:#ddd}.page-link{position:relative;float:left;padding:.5rem .75rem;margin-left:-1px;color:#0275d8;text-decoration:none;background-color:#fff;border:1px solid #ddd}.page-link:focus,.page-link:hover{color:#014c8c;background-color:#eceeef;border-color:#ddd}.pagination-lg .page-link{padding:.75rem 1.5rem;font-size:1.25rem}.pagination-lg .page-item:first-child .page-link{border-bottom-left-radius:.3rem;border-top-left-radius:.3rem}.pagination-lg .page-item:last-child .page-link{border-bottom-right-radius:.3rem;border-top-right-radius:.3rem}.pagination-sm .page-link{padding:.275rem .75rem;font-size:.875rem}.pagination-sm .page-item:first-child .page-link{border-bottom-left-radius:.2rem;border-top-left-radius:.2rem}.pagination-sm .page-item:last-child .page-link{border-bottom-right-radius:.2rem;border-top-right-radius:.2rem}.tag{display:inline-block;padding:.25em .4em;font-size:75%;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25rem}.tag:empty{display:none}.btn .tag{position:relative;top:-1px}a.tag:focus,a.tag:hover{color:#fff;text-decoration:none;cursor:pointer}.tag-pill{padding-right:.6em;padding-left:.6em;border-radius:10rem}.tag-default{background-color:#818a91}.tag-default[href]:focus,.tag-default[href]:hover{background-color:#687077}.tag-primary{background-color:#0275d8}.tag-primary[href]:focus,.tag-primary[href]:hover{background-color:#025aa5}.tag-success{background-color:#5cb85c}.tag-success[href]:focus,.tag-success[href]:hover{background-color:#449d44}.tag-info{background-color:#5bc0de}.tag-info[href]:focus,.tag-info[href]:hover{background-color:#31b0d5}.tag-warning{background-color:#f0ad4e}.tag-warning[href]:focus,.tag-warning[href]:hover{background-color:#ec971f}.tag-danger{background-color:#d9534f}.tag-danger[href]:focus,.tag-danger[href]:hover{background-color:#c9302c}.jumbotron{padding:2rem 1rem;margin-bottom:2rem;background-color:#eceeef;border-radius:.3rem}@media (min-width:576px){.jumbotron{padding:4rem 2rem}}.jumbotron-hr{border-top-color:#d0d5d8}.jumbotron-fluid{padding-right:0;padding-left:0;border-radius:0}.alert{padding:.75rem 1.25rem;margin-bottom:1rem;border:1px solid transparent;border-radius:.25rem}.alert-heading{color:inherit}.alert-link{font-weight:700}.alert-dismissible{padding-right:2.5rem}.alert-dismissible .close{position:relative;top:-.125rem;right:-1.25rem;color:inherit}.alert-success{background-color:#dff0d8;border-color:#d0e9c6;color:#3c763d}.alert-success hr{border-top-color:#c1e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{background-color:#d9edf7;border-color:#bcdff1;color:#31708f}.alert-info hr{border-top-color:#a6d5ec}.alert-info .alert-link{color:#245269}.alert-warning{background-color:#fcf8e3;border-color:#faf2cc;color:#8a6d3b}.alert-warning hr{border-top-color:#f7ecb5}.alert-warning .alert-link{color:#66512c}.alert-danger{background-color:#f2dede;border-color:#ebcccc;color:#a94442}.alert-danger hr{border-top-color:#e4b9b9}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{from{background-position:1rem 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:1rem 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:1rem 0}to{background-position:0 0}}.progress{display:block;width:100%;height:1rem;margin-bottom:1rem}.progress[value]{background-color:#eee;border:0;-webkit-appearance:none;-moz-appearance:none;appearance:none;border-radius:.25rem}.progress[value]::-ms-fill{background-color:#0074d9;border:0}.progress[value]::-moz-progress-bar{background-color:#0074d9;border-bottom-left-radius:.25rem;border-top-left-radius:.25rem}.progress[value]::-webkit-progress-value{background-color:#0074d9;border-bottom-left-radius:.25rem;border-top-left-radius:.25rem}.progress[value="100"]::-moz-progress-bar{border-bottom-right-radius:.25rem;border-top-right-radius:.25rem}.progress[value="100"]::-webkit-progress-value{border-bottom-right-radius:.25rem;border-top-right-radius:.25rem}.progress[value]::-webkit-progress-bar{background-color:#eee;border-radius:.25rem}.progress[value],base::-moz-progress-bar{background-color:#eee;border-radius:.25rem}@media screen and (min-width:0\0){.progress{background-color:#eee;border-radius:.25rem}.progress-bar{display:inline-block;height:1rem;text-indent:-999rem;background-color:#0074d9;border-bottom-left-radius:.25rem;border-top-left-radius:.25rem}.progress[width="100%"]{border-bottom-right-radius:.25rem;border-top-right-radius:.25rem}}.progress-striped[value]::-webkit-progress-value{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);-webkit-background-size:1rem 1rem;background-size:1rem 1rem}.progress-striped[value]::-moz-progress-bar{background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-size:1rem 1rem}.progress-striped[value]::-ms-fill{background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-size:1rem 1rem}@media screen and (min-width:0\0){.progress-bar-striped{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);-webkit-background-size:1rem 1rem;background-size:1rem 1rem}}.progress-animated[value]::-webkit-progress-value{-webkit-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-animated[value]::-moz-progress-bar{animation:progress-bar-stripes 2s linear infinite}@media screen and (min-width:0\0){.progress-animated .progress-bar-striped{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}}.progress-success[value]::-webkit-progress-value{background-color:#5cb85c}.progress-success[value]::-moz-progress-bar{background-color:#5cb85c}.progress-success[value]::-ms-fill{background-color:#5cb85c}@media screen and (min-width:0\0){.progress-success .progress-bar{background-color:#5cb85c}}.progress-info[value]::-webkit-progress-value{background-color:#5bc0de}.progress-info[value]::-moz-progress-bar{background-color:#5bc0de}.progress-info[value]::-ms-fill{background-color:#5bc0de}@media screen and (min-width:0\0){.progress-info .progress-bar{background-color:#5bc0de}}.progress-warning[value]::-webkit-progress-value{background-color:#f0ad4e}.progress-warning[value]::-moz-progress-bar{background-color:#f0ad4e}.progress-warning[value]::-ms-fill{background-color:#f0ad4e}@media screen and (min-width:0\0){.progress-warning .progress-bar{background-color:#f0ad4e}}.progress-danger[value]::-webkit-progress-value{background-color:#d9534f}.progress-danger[value]::-moz-progress-bar{background-color:#d9534f}.progress-danger[value]::-ms-fill{background-color:#d9534f}@media screen and (min-width:0\0){.progress-danger .progress-bar{background-color:#d9534f}}.media,.media-body{overflow:hidden}.media-body{width:10000px}.media-body,.media-left,.media-right{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-object{display:block}.media-object.img-thumbnail{max-width:none}.media-right{padding-left:10px}.media-left{padding-right:10px}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{padding-left:0;margin-bottom:0}.list-group-item{position:relative;display:block;padding:.75rem 1.25rem;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-right-radius:.25rem;border-top-left-radius:.25rem}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:.25rem;border-bottom-left-radius:.25rem}.list-group-item.disabled,.list-group-item.disabled:focus,.list-group-item.disabled:hover{color:#818a91;cursor:not-allowed;background-color:#eceeef}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text{color:#818a91}.list-group-item.active,.list-group-item.active:focus,.list-group-item.active:hover{z-index:2;color:#fff;text-decoration:none;background-color:#0275d8;border-color:#0275d8}.list-group-item.active .list-group-item-heading,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:focus .list-group-item-text,.list-group-item.active:hover .list-group-item-text{color:#a8d6fe}.list-group-flush .list-group-item{border-right:0;border-left:0;border-radius:0}.list-group-item-action{width:100%;color:#555;text-align:inherit}.list-group-item-action .list-group-item-heading{color:#333}.list-group-item-action:focus,.list-group-item-action:hover{color:#555;text-decoration:none;background-color:#f5f5f5}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success,button.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading,button.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:focus,a.list-group-item-success:hover,button.list-group-item-success:focus,button.list-group-item-success:hover{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,a.list-group-item-success.active:focus,a.list-group-item-success.active:hover,button.list-group-item-success.active,button.list-group-item-success.active:focus,button.list-group-item-success.active:hover{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info,button.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading,button.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:focus,a.list-group-item-info:hover,button.list-group-item-info:focus,button.list-group-item-info:hover{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,a.list-group-item-info.active:focus,a.list-group-item-info.active:hover,button.list-group-item-info.active,button.list-group-item-info.active:focus,button.list-group-item-info.active:hover{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning,button.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading,button.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:focus,a.list-group-item-warning:hover,button.list-group-item-warning:focus,button.list-group-item-warning:hover{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,a.list-group-item-warning.active:focus,a.list-group-item-warning.active:hover,button.list-group-item-warning.active,button.list-group-item-warning.active:focus,button.list-group-item-warning.active:hover{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger,button.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading,button.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:focus,a.list-group-item-danger:hover,button.list-group-item-danger:focus,button.list-group-item-danger:hover{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,a.list-group-item-danger.active:focus,a.list-group-item-danger.active:hover,button.list-group-item-danger.active,button.list-group-item-danger.active:focus,button.list-group-item-danger.active:hover{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-21by9{padding-bottom:42.857143%}.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive-4by3{padding-bottom:75%}.embed-responsive-1by1{padding-bottom:100%}.close{float:right;font-size:1.5rem;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;opacity:.2}.close:focus,.close:hover{color:#000;text-decoration:none;cursor:pointer;opacity:.5}button.close{padding:0;cursor:pointer;background:0 0;border:0;-webkit-appearance:none}.modal-open{overflow:hidden}.modal{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1050;display:none;overflow:hidden;outline:0}.modal.fade .modal-dialog{-webkit-transition:-webkit-transform .3s ease-out;transition:-webkit-transform .3s ease-out;-o-transition:-o-transform .3s ease-out;transition:transform .3s ease-out;transition:transform .3s ease-out,-webkit-transform .3s ease-out,-o-transform .3s ease-out;-webkit-transform:translate(0,-25%);-ms-transform:translate(0,-25%);-o-transform:translate(0,-25%);transform:translate(0,-25%)}.modal.in .modal-dialog{-webkit-transform:translate(0,0);-ms-transform:translate(0,0);-o-transform:translate(0,0);transform:translate(0,0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid rgba(0,0,0,.2);border-radius:.3rem;outline:0}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;background-color:#000}.modal-backdrop.fade{opacity:0}.modal-backdrop.in{opacity:.5}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5}.modal-header::after{content:"";display:table;clear:both}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.5}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer::after{content:"";display:table;clear:both}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:576px){.modal-dialog{max-width:600px;margin:30px auto}.modal-sm{max-width:300px}}@media (min-width:992px){.modal-lg{max-width:900px}}.tooltip{position:absolute;z-index:1070;display:block;font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;font-style:normal;font-weight:400;letter-spacing:normal;line-break:auto;line-height:1.5;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;white-space:normal;word-break:normal;word-spacing:normal;font-size:.875rem;word-wrap:break-word;opacity:0}.tooltip.in{opacity:.9}.tooltip.bs-tether-element-attached-bottom,.tooltip.tooltip-top{padding:5px 0;margin-top:-3px}.tooltip.bs-tether-element-attached-bottom .tooltip-inner::before,.tooltip.tooltip-top .tooltip-inner::before{bottom:0;left:50%;margin-left:-5px;content:"";border-width:5px 5px 0;border-top-color:#000}.tooltip.bs-tether-element-attached-left,.tooltip.tooltip-right{padding:0 5px;margin-left:3px}.tooltip.bs-tether-element-attached-left .tooltip-inner::before,.tooltip.tooltip-right .tooltip-inner::before{top:50%;left:0;margin-top:-5px;content:"";border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.bs-tether-element-attached-top,.tooltip.tooltip-bottom{padding:5px 0;margin-top:3px}.tooltip.bs-tether-element-attached-top .tooltip-inner::before,.tooltip.tooltip-bottom .tooltip-inner::before{top:0;left:50%;margin-left:-5px;content:"";border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bs-tether-element-attached-right,.tooltip.tooltip-left{padding:0 5px;margin-left:-3px}.tooltip.bs-tether-element-attached-right .tooltip-inner::before,.tooltip.tooltip-left .tooltip-inner::before{top:50%;right:0;margin-top:-5px;content:"";border-width:5px 0 5px 5px;border-left-color:#000}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;background-color:#000;border-radius:.25rem}.tooltip-inner::before{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.popover{position:absolute;top:0;left:0;z-index:1060;display:block;max-width:276px;padding:1px;font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;font-style:normal;font-weight:400;letter-spacing:normal;line-break:auto;line-height:1.5;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;white-space:normal;word-break:normal;word-spacing:normal;font-size:.875rem;word-wrap:break-word;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid rgba(0,0,0,.2);border-radius:.3rem}.popover.bs-tether-element-attached-bottom,.popover.popover-top{margin-top:-10px}.popover.bs-tether-element-attached-bottom::after,.popover.bs-tether-element-attached-bottom::before,.popover.popover-top::after,.popover.popover-top::before{left:50%;border-bottom-width:0}.popover.bs-tether-element-attached-bottom::before,.popover.popover-top::before{bottom:-11px;margin-left:-11px;border-top-color:rgba(0,0,0,.25)}.popover.bs-tether-element-attached-bottom::after,.popover.popover-top::after{bottom:-10px;margin-left:-10px;border-top-color:#fff}.popover.bs-tether-element-attached-left,.popover.popover-right{margin-left:10px}.popover.bs-tether-element-attached-left::after,.popover.bs-tether-element-attached-left::before,.popover.popover-right::after,.popover.popover-right::before{top:50%;border-left-width:0}.popover.bs-tether-element-attached-left::before,.popover.popover-right::before{left:-11px;margin-top:-11px;border-right-color:rgba(0,0,0,.25)}.popover.bs-tether-element-attached-left::after,.popover.popover-right::after{left:-10px;margin-top:-10px;border-right-color:#fff}.popover.bs-tether-element-attached-top,.popover.popover-bottom{margin-top:10px}.popover.bs-tether-element-attached-top::after,.popover.bs-tether-element-attached-top::before,.popover.popover-bottom::after,.popover.popover-bottom::before{left:50%;border-top-width:0}.popover.bs-tether-element-attached-top::before,.popover.popover-bottom::before{top:-11px;margin-left:-11px;border-bottom-color:rgba(0,0,0,.25)}.popover.bs-tether-element-attached-top::after,.popover.popover-bottom::after{top:-10px;margin-left:-10px;border-bottom-color:#f7f7f7}.popover.bs-tether-element-attached-top .popover-title::before,.popover.popover-bottom .popover-title::before{position:absolute;top:0;left:50%;display:block;width:20px;margin-left:-10px;content:"";border-bottom:1px solid #f7f7f7}.popover.bs-tether-element-attached-right,.popover.popover-left{margin-left:-10px}.popover.bs-tether-element-attached-right::after,.popover.bs-tether-element-attached-right::before,.popover.popover-left::after,.popover.popover-left::before{top:50%;border-right-width:0}.popover.bs-tether-element-attached-right::before,.popover.popover-left::before{right:-11px;margin-top:-11px;border-left-color:rgba(0,0,0,.25)}.popover.bs-tether-element-attached-right::after,.popover.popover-left::after{right:-10px;margin-top:-10px;border-left-color:#fff}.popover-title{padding:8px 14px;margin:0;font-size:1rem;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:.2375rem .2375rem 0 0}.popover-title:empty{display:none}.popover-content{padding:9px 14px}.popover::after,.popover::before{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover::before{content:"";border-width:11px}.popover::after{content:"";border-width:10px}.carousel{position:relative}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.carousel-item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.carousel-item>a>img,.carousel-inner>.carousel-item>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.carousel-item{-webkit-transition:-webkit-transform .6s ease-in-out;transition:-webkit-transform .6s ease-in-out;-o-transition:-o-transform .6s ease-in-out;transition:transform .6s ease-in-out;transition:transform .6s ease-in-out,-webkit-transform .6s ease-in-out,-o-transform .6s ease-in-out;-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000px;perspective:1000px}.carousel-inner>.carousel-item.active.right,.carousel-inner>.carousel-item.next{left:0;-webkit-transform:translate3d(100%,0,0);transform:translate3d(100%,0,0)}.carousel-inner>.carousel-item.active.left,.carousel-inner>.carousel-item.prev{left:0;-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0)}.carousel-inner>.carousel-item.active,.carousel-inner>.carousel-item.next.left,.carousel-inner>.carousel-item.prev.right{left:0;-webkit-transform:translate3d(0,0,0);transform:translate3d(0,0,0)}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;bottom:0;left:0;width:15%;font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6);opacity:.5}.carousel-control.left{background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.5)),to(rgba(0,0,0,.0001)));background-image:-webkit-linear-gradient(left,rgba(0,0,0,.5) 0%,rgba(0,0,0,.0001) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.5) 0%,rgba(0,0,0,.0001) 100%);background-image:linear-gradient(to right,rgba(0,0,0,.5) 0%,rgba(0,0,0,.0001) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1)}.carousel-control.right{right:0;left:auto;background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.0001)),to(rgba(0,0,0,.5)));background-image:-webkit-linear-gradient(left,rgba(0,0,0,.0001) 0%,rgba(0,0,0,.5) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.0001) 0%,rgba(0,0,0,.5) 100%);background-image:linear-gradient(to right,rgba(0,0,0,.0001) 0%,rgba(0,0,0,.5) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1)}.carousel-control:focus,.carousel-control:hover{color:#fff;text-decoration:none;outline:0;opacity:.9}.carousel-control .icon-next,.carousel-control .icon-prev{position:absolute;top:50%;z-index:5;display:inline-block;width:20px;height:20px;margin-top:-10px;font-family:serif;line-height:1}.carousel-control .icon-prev{left:50%;margin-left:-10px}.carousel-control .icon-next{right:50%;margin-right:-10px}.carousel-control .icon-prev::before{content:"\2039"}.carousel-control .icon-next::before{content:"\203a"}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;padding-left:0;margin-left:-30%;text-align:center;list-style:none}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;cursor:pointer;background-color:transparent;border:1px solid #fff;border-radius:10px}.carousel-indicators .active{width:12px;height:12px;margin:0;background-color:#fff}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6)}.carousel-caption .btn{text-shadow:none}@media (min-width:576px){.carousel-control .icon-next,.carousel-control .icon-prev{width:30px;height:30px;margin-top:-15px;font-size:30px}.carousel-control .icon-prev{margin-left:-15px}.carousel-control .icon-next{margin-right:-15px}.carousel-caption{right:20%;left:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.align-baseline{vertical-align:baseline!important}.align-top{vertical-align:top!important}.align-middle{vertical-align:middle!important}.align-bottom{vertical-align:bottom!important}.align-text-bottom{vertical-align:text-bottom!important}.align-text-top{vertical-align:text-top!important}.bg-faded{background-color:#f7f7f9}.bg-primary{background-color:#0275d8!important}a.bg-primary:focus,a.bg-primary:hover{background-color:#025aa5!important}.bg-success{background-color:#5cb85c!important}a.bg-success:focus,a.bg-success:hover{background-color:#449d44!important}.bg-info{background-color:#5bc0de!important}a.bg-info:focus,a.bg-info:hover{background-color:#31b0d5!important}.bg-warning{background-color:#f0ad4e!important}a.bg-warning:focus,a.bg-warning:hover{background-color:#ec971f!important}.bg-danger{background-color:#d9534f!important}a.bg-danger:focus,a.bg-danger:hover{background-color:#c9302c!important}.bg-inverse{background-color:#373a3c!important}a.bg-inverse:focus,a.bg-inverse:hover{background-color:#1f2021!important}.rounded{border-radius:.25rem}.rounded-top{border-top-right-radius:.25rem;border-top-left-radius:.25rem}.rounded-right{border-bottom-right-radius:.25rem;border-top-right-radius:.25rem}.rounded-bottom{border-bottom-right-radius:.25rem;border-bottom-left-radius:.25rem}.rounded-left{border-bottom-left-radius:.25rem;border-top-left-radius:.25rem}.rounded-circle{border-radius:50%}.clearfix::after{content:"";display:table;clear:both}.d-block{display:block!important}.d-inline-block{display:inline-block!important}.d-inline{display:inline!important}.float-xs-left{float:left!important}.float-xs-right{float:right!important}.float-xs-none{float:none!important}@media (min-width:576px){.float-sm-left{float:left!important}.float-sm-right{float:right!important}.float-sm-none{float:none!important}}@media (min-width:768px){.float-md-left{float:left!important}.float-md-right{float:right!important}.float-md-none{float:none!important}}@media (min-width:992px){.float-lg-left{float:left!important}.float-lg-right{float:right!important}.float-lg-none{float:none!important}}@media (min-width:1200px){.float-xl-left{float:left!important}.float-xl-right{float:right!important}.float-xl-none{float:none!important}}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.w-100{width:100%!important}.h-100{height:100%!important}.mx-auto{margin-right:auto!important;margin-left:auto!important}.m-0{margin:0 0!important}.mt-0{margin-top:0!important}.mr-0{margin-right:0!important}.mb-0{margin-bottom:0!important}.ml-0{margin-left:0!important}.mx-0{margin-right:0!important;margin-left:0!important}.my-0{margin-top:0!important;margin-bottom:0!important}.m-1{margin:1rem 1rem!important}.mt-1{margin-top:1rem!important}.mr-1{margin-right:1rem!important}.mb-1{margin-bottom:1rem!important}.ml-1{margin-left:1rem!important}.mx-1{margin-right:1rem!important;margin-left:1rem!important}.my-1{margin-top:1rem!important;margin-bottom:1rem!important}.m-2{margin:1.5rem 1.5rem!important}.mt-2{margin-top:1.5rem!important}.mr-2{margin-right:1.5rem!important}.mb-2{margin-bottom:1.5rem!important}.ml-2{margin-left:1.5rem!important}.mx-2{margin-right:1.5rem!important;margin-left:1.5rem!important}.my-2{margin-top:1.5rem!important;margin-bottom:1.5rem!important}.m-3{margin:3rem 3rem!important}.mt-3{margin-top:3rem!important}.mr-3{margin-right:3rem!important}.mb-3{margin-bottom:3rem!important}.ml-3{margin-left:3rem!important}.mx-3{margin-right:3rem!important;margin-left:3rem!important}.my-3{margin-top:3rem!important;margin-bottom:3rem!important}.p-0{padding:0 0!important}.pt-0{padding-top:0!important}.pr-0{padding-right:0!important}.pb-0{padding-bottom:0!important}.pl-0{padding-left:0!important}.px-0{padding-right:0!important;padding-left:0!important}.py-0{padding-top:0!important;padding-bottom:0!important}.p-1{padding:1rem 1rem!important}.pt-1{padding-top:1rem!important}.pr-1{padding-right:1rem!important}.pb-1{padding-bottom:1rem!important}.pl-1{padding-left:1rem!important}.px-1{padding-right:1rem!important;padding-left:1rem!important}.py-1{padding-top:1rem!important;padding-bottom:1rem!important}.p-2{padding:1.5rem 1.5rem!important}.pt-2{padding-top:1.5rem!important}.pr-2{padding-right:1.5rem!important}.pb-2{padding-bottom:1.5rem!important}.pl-2{padding-left:1.5rem!important}.px-2{padding-right:1.5rem!important;padding-left:1.5rem!important}.py-2{padding-top:1.5rem!important;padding-bottom:1.5rem!important}.p-3{padding:3rem 3rem!important}.pt-3{padding-top:3rem!important}.pr-3{padding-right:3rem!important}.pb-3{padding-bottom:3rem!important}.pl-3{padding-left:3rem!important}.px-3{padding-right:3rem!important;padding-left:3rem!important}.py-3{padding-top:3rem!important;padding-bottom:3rem!important}.pos-f-t{position:fixed;top:0;right:0;left:0;z-index:1030}.text-justify{text-align:justify!important}.text-nowrap{white-space:nowrap!important}.text-truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text-xs-left{text-align:left!important}.text-xs-right{text-align:right!important}.text-xs-center{text-align:center!important}@media (min-width:576px){.text-sm-left{text-align:left!important}.text-sm-right{text-align:right!important}.text-sm-center{text-align:center!important}}@media (min-width:768px){.text-md-left{text-align:left!important}.text-md-right{text-align:right!important}.text-md-center{text-align:center!important}}@media (min-width:992px){.text-lg-left{text-align:left!important}.text-lg-right{text-align:right!important}.text-lg-center{text-align:center!important}}@media (min-width:1200px){.text-xl-left{text-align:left!important}.text-xl-right{text-align:right!important}.text-xl-center{text-align:center!important}}.text-lowercase{text-transform:lowercase!important}.text-uppercase{text-transform:uppercase!important}.text-capitalize{text-transform:capitalize!important}.font-weight-normal{font-weight:400}.font-weight-bold{font-weight:700}.font-italic{font-style:italic}.text-white{color:#fff!important}.text-muted{color:#818a91!important}a.text-muted:focus,a.text-muted:hover{color:#687077!important}.text-primary{color:#0275d8!important}a.text-primary:focus,a.text-primary:hover{color:#025aa5!important}.text-success{color:#5cb85c!important}a.text-success:focus,a.text-success:hover{color:#449d44!important}.text-info{color:#5bc0de!important}a.text-info:focus,a.text-info:hover{color:#31b0d5!important}.text-warning{color:#f0ad4e!important}a.text-warning:focus,a.text-warning:hover{color:#ec971f!important}.text-danger{color:#d9534f!important}a.text-danger:focus,a.text-danger:hover{color:#c9302c!important}.text-gray-dark{color:#373a3c!important}a.text-gray-dark:focus,a.text-gray-dark:hover{color:#1f2021!important}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.invisible{visibility:hidden!important}.hidden-xs-up{display:none!important}@media (max-width:575px){.hidden-xs-down{display:none!important}}@media (min-width:576px){.hidden-sm-up{display:none!important}}@media (max-width:767px){.hidden-sm-down{display:none!important}}@media (min-width:768px){.hidden-md-up{display:none!important}}@media (max-width:991px){.hidden-md-down{display:none!important}}@media (min-width:992px){.hidden-lg-up{display:none!important}}@media (max-width:1199px){.hidden-lg-down{display:none!important}}@media (min-width:1200px){.hidden-xl-up{display:none!important}}.hidden-xl-down{display:none!important}.visible-print-block{display:none!important}@media print{.visible-print-block{display:block!important}}.visible-print-inline{display:none!important}@media print{.visible-print-inline{display:inline!important}}.visible-print-inline-block{display:none!important}@media print{.visible-print-inline-block{display:inline-block!important}}@media print{.hidden-print{display:none!important}} -/*# sourceMappingURL=bootstrap.min.css.map */ \ No newline at end of file diff --git a/packages/serenity-js/spec/support/server/index.ts b/packages/serenity-js/spec/support/server/index.ts deleted file mode 100644 index e6edf3a78e5..00000000000 --- a/packages/serenity-js/spec/support/server/index.ts +++ /dev/null @@ -1,36 +0,0 @@ -import express = require('express'); -import { Server } from 'http'; - -export class AppServer { - - private instance?: Server; - - start(port: number = 0) { - return () => new Promise((resolve, reject) => { - const server = configured(express()).listen(port, () => { - this.instance = server; - - resolve(this); - }); - }); - } - - demonstrating = (app: string) => `http://localhost:${ this.instance.address().port }/${ app }.html`; - - stop(): () => void { - return () => this.instance.close(); - } -} - -export function start(port: number = 8080) { - return configured(express()).listen(port); -} - -function configured(app) { - app.use('/js', express.static(__dirname + '/js')); - app.use('/css', express.static(__dirname + '/css')); - - app.use(express.static(__dirname + '/../../cookbook/apps', { extensions: ['html'] })); - - return app; -} diff --git a/packages/serenity-js/spec/support/server/js/angular.js b/packages/serenity-js/spec/support/server/js/angular.js deleted file mode 100644 index a3ea6c60975..00000000000 --- a/packages/serenity-js/spec/support/server/js/angular.js +++ /dev/null @@ -1,32895 +0,0 @@ -/** - * @license AngularJS v1.6.0 - * (c) 2010-2016 Google, Inc. http://angularjs.org - * License: MIT - */ -(function(window) {'use strict'; - -/** - * @description - * - * This object provides a utility for producing rich Error messages within - * Angular. It can be called as follows: - * - * var exampleMinErr = minErr('example'); - * throw exampleMinErr('one', 'This {0} is {1}', foo, bar); - * - * The above creates an instance of minErr in the example namespace. The - * resulting error will have a namespaced error code of example.one. The - * resulting error will replace {0} with the value of foo, and {1} with the - * value of bar. The object is not restricted in the number of arguments it can - * take. - * - * If fewer arguments are specified than necessary for interpolation, the extra - * interpolation markers will be preserved in the final string. - * - * Since data will be parsed statically during a build step, some restrictions - * are applied with respect to how minErr instances are created and called. - * Instances should have names of the form namespaceMinErr for a minErr created - * using minErr('namespace') . Error codes, namespaces and template strings - * should all be static strings, not variables or general expressions. - * - * @param {string} module The namespace to use for the new minErr instance. - * @param {function} ErrorConstructor Custom error constructor to be instantiated when returning - * error from returned function, for cases when a particular type of error is useful. - * @returns {function(code:string, template:string, ...templateArgs): Error} minErr instance - */ - -function minErr(module, ErrorConstructor) { - ErrorConstructor = ErrorConstructor || Error; - return function() { - var SKIP_INDEXES = 2; - - var templateArgs = arguments, - code = templateArgs[0], - message = '[' + (module ? module + ':' : '') + code + '] ', - template = templateArgs[1], - paramPrefix, i; - - message += template.replace(/\{\d+\}/g, function(match) { - var index = +match.slice(1, -1), - shiftedIndex = index + SKIP_INDEXES; - - if (shiftedIndex < templateArgs.length) { - return toDebugString(templateArgs[shiftedIndex]); - } - - return match; - }); - - message += '\nhttp://errors.angularjs.org/1.6.0/' + - (module ? module + '/' : '') + code; - - for (i = SKIP_INDEXES, paramPrefix = '?'; i < templateArgs.length; i++, paramPrefix = '&') { - message += paramPrefix + 'p' + (i - SKIP_INDEXES) + '=' + - encodeURIComponent(toDebugString(templateArgs[i])); - } - - return new ErrorConstructor(message); - }; -} - -/* We need to tell ESLint what variables are being exported */ -/* exported - angular, - msie, - jqLite, - jQuery, - slice, - splice, - push, - toString, - ngMinErr, - angularModule, - uid, - REGEX_STRING_REGEXP, - VALIDITY_STATE_PROPERTY, - - lowercase, - uppercase, - manualLowercase, - manualUppercase, - nodeName_, - isArrayLike, - forEach, - forEachSorted, - reverseParams, - nextUid, - setHashKey, - extend, - toInt, - inherit, - merge, - noop, - identity, - valueFn, - isUndefined, - isDefined, - isObject, - isBlankObject, - isString, - isNumber, - isNumberNaN, - isDate, - isArray, - isFunction, - isRegExp, - isWindow, - isScope, - isFile, - isFormData, - isBlob, - isBoolean, - isPromiseLike, - trim, - escapeForRegexp, - isElement, - makeMap, - includes, - arrayRemove, - copy, - equals, - csp, - jq, - concat, - sliceArgs, - bind, - toJsonReplacer, - toJson, - fromJson, - convertTimezoneToLocal, - timezoneToOffset, - startingTag, - tryDecodeURIComponent, - parseKeyValue, - toKeyValue, - encodeUriSegment, - encodeUriQuery, - angularInit, - bootstrap, - getTestability, - snake_case, - bindJQuery, - assertArg, - assertArgFn, - assertNotHasOwnProperty, - getter, - getBlockNodes, - hasOwnProperty, - createMap, - stringify, - - NODE_TYPE_ELEMENT, - NODE_TYPE_ATTRIBUTE, - NODE_TYPE_TEXT, - NODE_TYPE_COMMENT, - NODE_TYPE_DOCUMENT, - NODE_TYPE_DOCUMENT_FRAGMENT -*/ - -//////////////////////////////////// - -/** - * @ngdoc module - * @name ng - * @module ng - * @installation - * @description - * - * # ng (core module) - * The ng module is loaded by default when an AngularJS application is started. The module itself - * contains the essential components for an AngularJS application to function. The table below - * lists a high level breakdown of each of the services/factories, filters, directives and testing - * components available within this core module. - * - *
- */ - -var REGEX_STRING_REGEXP = /^\/(.+)\/([a-z]*)$/; - -// The name of a form control's ValidityState property. -// This is used so that it's possible for internal tests to create mock ValidityStates. -var VALIDITY_STATE_PROPERTY = 'validity'; - - -var hasOwnProperty = Object.prototype.hasOwnProperty; - -/** - * @ngdoc function - * @name angular.lowercase - * @module ng - * @kind function - * - * @deprecated - * sinceVersion="1.5.0" - * removeVersion="1.7.0" - * Use [String.prototype.toLowerCase](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/toLowerCase) instead. - * - * @description Converts the specified string to lowercase. - * @param {string} string String to be converted to lowercase. - * @returns {string} Lowercased string. - */ -var lowercase = function(string) {return isString(string) ? string.toLowerCase() : string;}; - -/** - * @ngdoc function - * @name angular.uppercase - * @module ng - * @kind function - * - * @deprecated - * sinceVersion="1.5.0" - * removeVersion="1.7.0" - * Use [String.prototype.toUpperCase](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/toUpperCase) instead. - * - * @description Converts the specified string to uppercase. - * @param {string} string String to be converted to uppercase. - * @returns {string} Uppercased string. - */ -var uppercase = function(string) {return isString(string) ? string.toUpperCase() : string;}; - - -var manualLowercase = function(s) { - /* eslint-disable no-bitwise */ - return isString(s) - ? s.replace(/[A-Z]/g, function(ch) {return String.fromCharCode(ch.charCodeAt(0) | 32);}) - : s; - /* eslint-enable */ -}; -var manualUppercase = function(s) { - /* eslint-disable no-bitwise */ - return isString(s) - ? s.replace(/[a-z]/g, function(ch) {return String.fromCharCode(ch.charCodeAt(0) & ~32);}) - : s; - /* eslint-enable */ -}; - - -// String#toLowerCase and String#toUpperCase don't produce correct results in browsers with Turkish -// locale, for this reason we need to detect this case and redefine lowercase/uppercase methods -// with correct but slower alternatives. See https://github.com/angular/angular.js/issues/11387 -if ('i' !== 'I'.toLowerCase()) { - lowercase = manualLowercase; - uppercase = manualUppercase; -} - - -var - msie, // holds major version number for IE, or NaN if UA is not IE. - jqLite, // delay binding since jQuery could be loaded after us. - jQuery, // delay binding - slice = [].slice, - splice = [].splice, - push = [].push, - toString = Object.prototype.toString, - getPrototypeOf = Object.getPrototypeOf, - ngMinErr = minErr('ng'), - - /** @name angular */ - angular = window.angular || (window.angular = {}), - angularModule, - uid = 0; - -// Support: IE 9-11 only -/** - * documentMode is an IE-only property - * http://msdn.microsoft.com/en-us/library/ie/cc196988(v=vs.85).aspx - */ -msie = window.document.documentMode; - - -/** - * @private - * @param {*} obj - * @return {boolean} Returns true if `obj` is an array or array-like object (NodeList, Arguments, - * String ...) - */ -function isArrayLike(obj) { - - // `null`, `undefined` and `window` are not array-like - if (obj == null || isWindow(obj)) return false; - - // arrays, strings and jQuery/jqLite objects are array like - // * jqLite is either the jQuery or jqLite constructor function - // * we have to check the existence of jqLite first as this method is called - // via the forEach method when constructing the jqLite object in the first place - if (isArray(obj) || isString(obj) || (jqLite && obj instanceof jqLite)) return true; - - // Support: iOS 8.2 (not reproducible in simulator) - // "length" in obj used to prevent JIT error (gh-11508) - var length = 'length' in Object(obj) && obj.length; - - // NodeList objects (with `item` method) and - // other objects with suitable length characteristics are array-like - return isNumber(length) && - (length >= 0 && ((length - 1) in obj || obj instanceof Array) || typeof obj.item === 'function'); - -} - -/** - * @ngdoc function - * @name angular.forEach - * @module ng - * @kind function - * - * @description - * Invokes the `iterator` function once for each item in `obj` collection, which can be either an - * object or an array. The `iterator` function is invoked with `iterator(value, key, obj)`, where `value` - * is the value of an object property or an array element, `key` is the object property key or - * array element index and obj is the `obj` itself. Specifying a `context` for the function is optional. - * - * It is worth noting that `.forEach` does not iterate over inherited properties because it filters - * using the `hasOwnProperty` method. - * - * Unlike ES262's - * [Array.prototype.forEach](http://www.ecma-international.org/ecma-262/5.1/#sec-15.4.4.18), - * providing 'undefined' or 'null' values for `obj` will not throw a TypeError, but rather just - * return the value provided. - * - ```js - var values = {name: 'misko', gender: 'male'}; - var log = []; - angular.forEach(values, function(value, key) { - this.push(key + ': ' + value); - }, log); - expect(log).toEqual(['name: misko', 'gender: male']); - ``` - * - * @param {Object|Array} obj Object to iterate over. - * @param {Function} iterator Iterator function. - * @param {Object=} context Object to become context (`this`) for the iterator function. - * @returns {Object|Array} Reference to `obj`. - */ - -function forEach(obj, iterator, context) { - var key, length; - if (obj) { - if (isFunction(obj)) { - for (key in obj) { - if (key !== 'prototype' && key !== 'length' && key !== 'name' && obj.hasOwnProperty(key)) { - iterator.call(context, obj[key], key, obj); - } - } - } else if (isArray(obj) || isArrayLike(obj)) { - var isPrimitive = typeof obj !== 'object'; - for (key = 0, length = obj.length; key < length; key++) { - if (isPrimitive || key in obj) { - iterator.call(context, obj[key], key, obj); - } - } - } else if (obj.forEach && obj.forEach !== forEach) { - obj.forEach(iterator, context, obj); - } else if (isBlankObject(obj)) { - // createMap() fast path --- Safe to avoid hasOwnProperty check because prototype chain is empty - for (key in obj) { - iterator.call(context, obj[key], key, obj); - } - } else if (typeof obj.hasOwnProperty === 'function') { - // Slow path for objects inheriting Object.prototype, hasOwnProperty check needed - for (key in obj) { - if (obj.hasOwnProperty(key)) { - iterator.call(context, obj[key], key, obj); - } - } - } else { - // Slow path for objects which do not have a method `hasOwnProperty` - for (key in obj) { - if (hasOwnProperty.call(obj, key)) { - iterator.call(context, obj[key], key, obj); - } - } - } - } - return obj; -} - -function forEachSorted(obj, iterator, context) { - var keys = Object.keys(obj).sort(); - for (var i = 0; i < keys.length; i++) { - iterator.call(context, obj[keys[i]], keys[i]); - } - return keys; -} - - -/** - * when using forEach the params are value, key, but it is often useful to have key, value. - * @param {function(string, *)} iteratorFn - * @returns {function(*, string)} - */ -function reverseParams(iteratorFn) { - return function(value, key) {iteratorFn(key, value);}; -} - -/** - * A consistent way of creating unique IDs in angular. - * - * Using simple numbers allows us to generate 28.6 million unique ids per second for 10 years before - * we hit number precision issues in JavaScript. - * - * Math.pow(2,53) / 60 / 60 / 24 / 365 / 10 = 28.6M - * - * @returns {number} an unique alpha-numeric string - */ -function nextUid() { - return ++uid; -} - - -/** - * Set or clear the hashkey for an object. - * @param obj object - * @param h the hashkey (!truthy to delete the hashkey) - */ -function setHashKey(obj, h) { - if (h) { - obj.$$hashKey = h; - } else { - delete obj.$$hashKey; - } -} - - -function baseExtend(dst, objs, deep) { - var h = dst.$$hashKey; - - for (var i = 0, ii = objs.length; i < ii; ++i) { - var obj = objs[i]; - if (!isObject(obj) && !isFunction(obj)) continue; - var keys = Object.keys(obj); - for (var j = 0, jj = keys.length; j < jj; j++) { - var key = keys[j]; - var src = obj[key]; - - if (deep && isObject(src)) { - if (isDate(src)) { - dst[key] = new Date(src.valueOf()); - } else if (isRegExp(src)) { - dst[key] = new RegExp(src); - } else if (src.nodeName) { - dst[key] = src.cloneNode(true); - } else if (isElement(src)) { - dst[key] = src.clone(); - } else { - if (!isObject(dst[key])) dst[key] = isArray(src) ? [] : {}; - baseExtend(dst[key], [src], true); - } - } else { - dst[key] = src; - } - } - } - - setHashKey(dst, h); - return dst; -} - -/** - * @ngdoc function - * @name angular.extend - * @module ng - * @kind function - * - * @description - * Extends the destination object `dst` by copying own enumerable properties from the `src` object(s) - * to `dst`. You can specify multiple `src` objects. If you want to preserve original objects, you can do so - * by passing an empty object as the target: `var object = angular.extend({}, object1, object2)`. - * - * **Note:** Keep in mind that `angular.extend` does not support recursive merge (deep copy). Use - * {@link angular.merge} for this. - * - * @param {Object} dst Destination object. - * @param {...Object} src Source object(s). - * @returns {Object} Reference to `dst`. - */ -function extend(dst) { - return baseExtend(dst, slice.call(arguments, 1), false); -} - - -/** -* @ngdoc function -* @name angular.merge -* @module ng -* @kind function -* -* @description -* Deeply extends the destination object `dst` by copying own enumerable properties from the `src` object(s) -* to `dst`. You can specify multiple `src` objects. If you want to preserve original objects, you can do so -* by passing an empty object as the target: `var object = angular.merge({}, object1, object2)`. -* -* Unlike {@link angular.extend extend()}, `merge()` recursively descends into object properties of source -* objects, performing a deep copy. -* -* @param {Object} dst Destination object. -* @param {...Object} src Source object(s). -* @returns {Object} Reference to `dst`. -*/ -function merge(dst) { - return baseExtend(dst, slice.call(arguments, 1), true); -} - - - -function toInt(str) { - return parseInt(str, 10); -} - -var isNumberNaN = Number.isNaN || function isNumberNaN(num) { - // eslint-disable-next-line no-self-compare - return num !== num; -}; - - -function inherit(parent, extra) { - return extend(Object.create(parent), extra); -} - -/** - * @ngdoc function - * @name angular.noop - * @module ng - * @kind function - * - * @description - * A function that performs no operations. This function can be useful when writing code in the - * functional style. - ```js - function foo(callback) { - var result = calculateResult(); - (callback || angular.noop)(result); - } - ``` - */ -function noop() {} -noop.$inject = []; - - -/** - * @ngdoc function - * @name angular.identity - * @module ng - * @kind function - * - * @description - * A function that returns its first argument. This function is useful when writing code in the - * functional style. - * - ```js - function transformer(transformationFn, value) { - return (transformationFn || angular.identity)(value); - }; - - // E.g. - function getResult(fn, input) { - return (fn || angular.identity)(input); - }; - - getResult(function(n) { return n * 2; }, 21); // returns 42 - getResult(null, 21); // returns 21 - getResult(undefined, 21); // returns 21 - ``` - * - * @param {*} value to be returned. - * @returns {*} the value passed in. - */ -function identity($) {return $;} -identity.$inject = []; - - -function valueFn(value) {return function valueRef() {return value;};} - -function hasCustomToString(obj) { - return isFunction(obj.toString) && obj.toString !== toString; -} - - -/** - * @ngdoc function - * @name angular.isUndefined - * @module ng - * @kind function - * - * @description - * Determines if a reference is undefined. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is undefined. - */ -function isUndefined(value) {return typeof value === 'undefined';} - - -/** - * @ngdoc function - * @name angular.isDefined - * @module ng - * @kind function - * - * @description - * Determines if a reference is defined. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is defined. - */ -function isDefined(value) {return typeof value !== 'undefined';} - - -/** - * @ngdoc function - * @name angular.isObject - * @module ng - * @kind function - * - * @description - * Determines if a reference is an `Object`. Unlike `typeof` in JavaScript, `null`s are not - * considered to be objects. Note that JavaScript arrays are objects. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is an `Object` but not `null`. - */ -function isObject(value) { - // http://jsperf.com/isobject4 - return value !== null && typeof value === 'object'; -} - - -/** - * Determine if a value is an object with a null prototype - * - * @returns {boolean} True if `value` is an `Object` with a null prototype - */ -function isBlankObject(value) { - return value !== null && typeof value === 'object' && !getPrototypeOf(value); -} - - -/** - * @ngdoc function - * @name angular.isString - * @module ng - * @kind function - * - * @description - * Determines if a reference is a `String`. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `String`. - */ -function isString(value) {return typeof value === 'string';} - - -/** - * @ngdoc function - * @name angular.isNumber - * @module ng - * @kind function - * - * @description - * Determines if a reference is a `Number`. - * - * This includes the "special" numbers `NaN`, `+Infinity` and `-Infinity`. - * - * If you wish to exclude these then you can use the native - * [`isFinite'](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isFinite) - * method. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `Number`. - */ -function isNumber(value) {return typeof value === 'number';} - - -/** - * @ngdoc function - * @name angular.isDate - * @module ng - * @kind function - * - * @description - * Determines if a value is a date. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `Date`. - */ -function isDate(value) { - return toString.call(value) === '[object Date]'; -} - - -/** - * @ngdoc function - * @name angular.isArray - * @module ng - * @kind function - * - * @description - * Determines if a reference is an `Array`. Alias of Array.isArray. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is an `Array`. - */ -var isArray = Array.isArray; - -/** - * @ngdoc function - * @name angular.isFunction - * @module ng - * @kind function - * - * @description - * Determines if a reference is a `Function`. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `Function`. - */ -function isFunction(value) {return typeof value === 'function';} - - -/** - * Determines if a value is a regular expression object. - * - * @private - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `RegExp`. - */ -function isRegExp(value) { - return toString.call(value) === '[object RegExp]'; -} - - -/** - * Checks if `obj` is a window object. - * - * @private - * @param {*} obj Object to check - * @returns {boolean} True if `obj` is a window obj. - */ -function isWindow(obj) { - return obj && obj.window === obj; -} - - -function isScope(obj) { - return obj && obj.$evalAsync && obj.$watch; -} - - -function isFile(obj) { - return toString.call(obj) === '[object File]'; -} - - -function isFormData(obj) { - return toString.call(obj) === '[object FormData]'; -} - - -function isBlob(obj) { - return toString.call(obj) === '[object Blob]'; -} - - -function isBoolean(value) { - return typeof value === 'boolean'; -} - - -function isPromiseLike(obj) { - return obj && isFunction(obj.then); -} - - -var TYPED_ARRAY_REGEXP = /^\[object (?:Uint8|Uint8Clamped|Uint16|Uint32|Int8|Int16|Int32|Float32|Float64)Array]$/; -function isTypedArray(value) { - return value && isNumber(value.length) && TYPED_ARRAY_REGEXP.test(toString.call(value)); -} - -function isArrayBuffer(obj) { - return toString.call(obj) === '[object ArrayBuffer]'; -} - - -var trim = function(value) { - return isString(value) ? value.trim() : value; -}; - -// Copied from: -// http://docs.closure-library.googlecode.com/git/local_closure_goog_string_string.js.source.html#line1021 -// Prereq: s is a string. -var escapeForRegexp = function(s) { - return s - .replace(/([-()[\]{}+?*.$^|,:#= 0) { - array.splice(index, 1); - } - return index; -} - -/** - * @ngdoc function - * @name angular.copy - * @module ng - * @kind function - * - * @description - * Creates a deep copy of `source`, which should be an object or an array. - * - * * If no destination is supplied, a copy of the object or array is created. - * * If a destination is provided, all of its elements (for arrays) or properties (for objects) - * are deleted and then all elements/properties from the source are copied to it. - * * If `source` is not an object or array (inc. `null` and `undefined`), `source` is returned. - * * If `source` is identical to `destination` an exception will be thrown. - * - *
- *
- * Only enumerable properties are taken into account. Non-enumerable properties (both on `source` - * and on `destination`) will be ignored. - *
- * - * @param {*} source The source that will be used to make a copy. - * Can be any type, including primitives, `null`, and `undefined`. - * @param {(Object|Array)=} destination Destination into which the source is copied. If - * provided, must be of the same type as `source`. - * @returns {*} The copy or updated `destination`, if `destination` was specified. - * - * @example - - -
-
-
-
- Gender: -
- - -
- 
form = {{user | json}}
- 
master = {{master | json}}
-
- - - // Module: copyExample - angular. - module('copyExample', []). - controller('ExampleController', ['$scope', function($scope) { - $scope.master = {}; - - $scope.reset = function() { - // Example with 1 argument - $scope.user = angular.copy($scope.master); - }; - - $scope.update = function(user) { - // Example with 2 arguments - angular.copy(user, $scope.master); - }; - - $scope.reset(); - }]); - - - */ -function copy(source, destination) { - var stackSource = []; - var stackDest = []; - - if (destination) { - if (isTypedArray(destination) || isArrayBuffer(destination)) { - throw ngMinErr('cpta', 'Can\'t copy! TypedArray destination cannot be mutated.'); - } - if (source === destination) { - throw ngMinErr('cpi', 'Can\'t copy! Source and destination are identical.'); - } - - // Empty the destination object - if (isArray(destination)) { - destination.length = 0; - } else { - forEach(destination, function(value, key) { - if (key !== '$$hashKey') { - delete destination[key]; - } - }); - } - - stackSource.push(source); - stackDest.push(destination); - return copyRecurse(source, destination); - } - - return copyElement(source); - - function copyRecurse(source, destination) { - var h = destination.$$hashKey; - var key; - if (isArray(source)) { - for (var i = 0, ii = source.length; i < ii; i++) { - destination.push(copyElement(source[i])); - } - } else if (isBlankObject(source)) { - // createMap() fast path --- Safe to avoid hasOwnProperty check because prototype chain is empty - for (key in source) { - destination[key] = copyElement(source[key]); - } - } else if (source && typeof source.hasOwnProperty === 'function') { - // Slow path, which must rely on hasOwnProperty - for (key in source) { - if (source.hasOwnProperty(key)) { - destination[key] = copyElement(source[key]); - } - } - } else { - // Slowest path --- hasOwnProperty can't be called as a method - for (key in source) { - if (hasOwnProperty.call(source, key)) { - destination[key] = copyElement(source[key]); - } - } - } - setHashKey(destination, h); - return destination; - } - - function copyElement(source) { - // Simple values - if (!isObject(source)) { - return source; - } - - // Already copied values - var index = stackSource.indexOf(source); - if (index !== -1) { - return stackDest[index]; - } - - if (isWindow(source) || isScope(source)) { - throw ngMinErr('cpws', - 'Can\'t copy! Making copies of Window or Scope instances is not supported.'); - } - - var needsRecurse = false; - var destination = copyType(source); - - if (destination === undefined) { - destination = isArray(source) ? [] : Object.create(getPrototypeOf(source)); - needsRecurse = true; - } - - stackSource.push(source); - stackDest.push(destination); - - return needsRecurse - ? copyRecurse(source, destination) - : destination; - } - - function copyType(source) { - switch (toString.call(source)) { - case '[object Int8Array]': - case '[object Int16Array]': - case '[object Int32Array]': - case '[object Float32Array]': - case '[object Float64Array]': - case '[object Uint8Array]': - case '[object Uint8ClampedArray]': - case '[object Uint16Array]': - case '[object Uint32Array]': - return new source.constructor(copyElement(source.buffer), source.byteOffset, source.length); - - case '[object ArrayBuffer]': - // Support: IE10 - if (!source.slice) { - // If we're in this case we know the environment supports ArrayBuffer - /* eslint-disable no-undef */ - var copied = new ArrayBuffer(source.byteLength); - new Uint8Array(copied).set(new Uint8Array(source)); - /* eslint-enable */ - return copied; - } - return source.slice(0); - - case '[object Boolean]': - case '[object Number]': - case '[object String]': - case '[object Date]': - return new source.constructor(source.valueOf()); - - case '[object RegExp]': - var re = new RegExp(source.source, source.toString().match(/[^/]*$/)[0]); - re.lastIndex = source.lastIndex; - return re; - - case '[object Blob]': - return new source.constructor([source], {type: source.type}); - } - - if (isFunction(source.cloneNode)) { - return source.cloneNode(true); - } - } -} - - -/** - * @ngdoc function - * @name angular.equals - * @module ng - * @kind function - * - * @description - * Determines if two objects or two values are equivalent. Supports value types, regular - * expressions, arrays and objects. - * - * Two objects or values are considered equivalent if at least one of the following is true: - * - * * Both objects or values pass `===` comparison. - * * Both objects or values are of the same type and all of their properties are equal by - * comparing them with `angular.equals`. - * * Both values are NaN. (In JavaScript, NaN == NaN => false. But we consider two NaN as equal) - * * Both values represent the same regular expression (In JavaScript, - * /abc/ == /abc/ => false. But we consider two regular expressions as equal when their textual - * representation matches). - * - * During a property comparison, properties of `function` type and properties with names - * that begin with `$` are ignored. - * - * Scope and DOMWindow objects are being compared only by identify (`===`). - * - * @param {*} o1 Object or value to compare. - * @param {*} o2 Object or value to compare. - * @returns {boolean} True if arguments are equal. - * - * @example - - -
-
-

User 1

- Name: - Age: - -

User 2

- Name: - Age: - -
-
- -
- User 1: 
{{user1 | json}}
- User 2: 
{{user2 | json}}
- Equal: 
{{result}}
-
-
- - - angular.module('equalsExample', []).controller('ExampleController', ['$scope', function($scope) { - $scope.user1 = {}; - $scope.user2 = {}; - $scope.compare = function() { - $scope.result = angular.equals($scope.user1, $scope.user2); - }; - }]); - - - */ -function equals(o1, o2) { - if (o1 === o2) return true; - if (o1 === null || o2 === null) return false; - // eslint-disable-next-line no-self-compare - if (o1 !== o1 && o2 !== o2) return true; // NaN === NaN - var t1 = typeof o1, t2 = typeof o2, length, key, keySet; - if (t1 === t2 && t1 === 'object') { - if (isArray(o1)) { - if (!isArray(o2)) return false; - if ((length = o1.length) === o2.length) { - for (key = 0; key < length; key++) { - if (!equals(o1[key], o2[key])) return false; - } - return true; - } - } else if (isDate(o1)) { - if (!isDate(o2)) return false; - return equals(o1.getTime(), o2.getTime()); - } else if (isRegExp(o1)) { - if (!isRegExp(o2)) return false; - return o1.toString() === o2.toString(); - } else { - if (isScope(o1) || isScope(o2) || isWindow(o1) || isWindow(o2) || - isArray(o2) || isDate(o2) || isRegExp(o2)) return false; - keySet = createMap(); - for (key in o1) { - if (key.charAt(0) === '$' || isFunction(o1[key])) continue; - if (!equals(o1[key], o2[key])) return false; - keySet[key] = true; - } - for (key in o2) { - if (!(key in keySet) && - key.charAt(0) !== '$' && - isDefined(o2[key]) && - !isFunction(o2[key])) return false; - } - return true; - } - } - return false; -} - -var csp = function() { - if (!isDefined(csp.rules)) { - - - var ngCspElement = (window.document.querySelector('[ng-csp]') || - window.document.querySelector('[data-ng-csp]')); - - if (ngCspElement) { - var ngCspAttribute = ngCspElement.getAttribute('ng-csp') || - ngCspElement.getAttribute('data-ng-csp'); - csp.rules = { - noUnsafeEval: !ngCspAttribute || (ngCspAttribute.indexOf('no-unsafe-eval') !== -1), - noInlineStyle: !ngCspAttribute || (ngCspAttribute.indexOf('no-inline-style') !== -1) - }; - } else { - csp.rules = { - noUnsafeEval: noUnsafeEval(), - noInlineStyle: false - }; - } - } - - return csp.rules; - - function noUnsafeEval() { - try { - // eslint-disable-next-line no-new, no-new-func - new Function(''); - return false; - } catch (e) { - return true; - } - } -}; - -/** - * @ngdoc directive - * @module ng - * @name ngJq - * - * @element ANY - * @param {string=} ngJq the name of the library available under `window` - * to be used for angular.element - * @description - * Use this directive to force the angular.element library. This should be - * used to force either jqLite by leaving ng-jq blank or setting the name of - * the jquery variable under window (eg. jQuery). - * - * Since angular looks for this directive when it is loaded (doesn't wait for the - * DOMContentLoaded event), it must be placed on an element that comes before the script - * which loads angular. Also, only the first instance of `ng-jq` will be used and all - * others ignored. - * - * @example - * This example shows how to force jqLite using the `ngJq` directive to the `html` tag. - ```html - - - ... - ... - - ``` - * @example - * This example shows how to use a jQuery based library of a different name. - * The library name must be available at the top most 'window'. - ```html - - - ... - ... - - ``` - */ -var jq = function() { - if (isDefined(jq.name_)) return jq.name_; - var el; - var i, ii = ngAttrPrefixes.length, prefix, name; - for (i = 0; i < ii; ++i) { - prefix = ngAttrPrefixes[i]; - el = window.document.querySelector('[' + prefix.replace(':', '\\:') + 'jq]'); - if (el) { - name = el.getAttribute(prefix + 'jq'); - break; - } - } - - return (jq.name_ = name); -}; - -function concat(array1, array2, index) { - return array1.concat(slice.call(array2, index)); -} - -function sliceArgs(args, startIndex) { - return slice.call(args, startIndex || 0); -} - - -/** - * @ngdoc function - * @name angular.bind - * @module ng - * @kind function - * - * @description - * Returns a function which calls function `fn` bound to `self` (`self` becomes the `this` for - * `fn`). You can supply optional `args` that are prebound to the function. This feature is also - * known as [partial application](http://en.wikipedia.org/wiki/Partial_application), as - * distinguished from [function currying](http://en.wikipedia.org/wiki/Currying#Contrast_with_partial_function_application). - * - * @param {Object} self Context which `fn` should be evaluated in. - * @param {function()} fn Function to be bound. - * @param {...*} args Optional arguments to be prebound to the `fn` function call. - * @returns {function()} Function that wraps the `fn` with all the specified bindings. - */ -function bind(self, fn) { - var curryArgs = arguments.length > 2 ? sliceArgs(arguments, 2) : []; - if (isFunction(fn) && !(fn instanceof RegExp)) { - return curryArgs.length - ? function() { - return arguments.length - ? fn.apply(self, concat(curryArgs, arguments, 0)) - : fn.apply(self, curryArgs); - } - : function() { - return arguments.length - ? fn.apply(self, arguments) - : fn.call(self); - }; - } else { - // In IE, native methods are not functions so they cannot be bound (note: they don't need to be). - return fn; - } -} - - -function toJsonReplacer(key, value) { - var val = value; - - if (typeof key === 'string' && key.charAt(0) === '$' && key.charAt(1) === '$') { - val = undefined; - } else if (isWindow(value)) { - val = '$WINDOW'; - } else if (value && window.document === value) { - val = '$DOCUMENT'; - } else if (isScope(value)) { - val = '$SCOPE'; - } - - return val; -} - - -/** - * @ngdoc function - * @name angular.toJson - * @module ng - * @kind function - * - * @description - * Serializes input into a JSON-formatted string. Properties with leading $$ characters will be - * stripped since angular uses this notation internally. - * - * @param {Object|Array|Date|string|number|boolean} obj Input to be serialized into JSON. - * @param {boolean|number} [pretty=2] If set to true, the JSON output will contain newlines and whitespace. - * If set to an integer, the JSON output will contain that many spaces per indentation. - * @returns {string|undefined} JSON-ified string representing `obj`. - * @knownIssue - * - * The Safari browser throws a `RangeError` instead of returning `null` when it tries to stringify a `Date` - * object with an invalid date value. The only reliable way to prevent this is to monkeypatch the - * `Date.prototype.toJSON` method as follows: - * - * ``` - * var _DatetoJSON = Date.prototype.toJSON; - * Date.prototype.toJSON = function() { - * try { - * return _DatetoJSON.call(this); - * } catch(e) { - * if (e instanceof RangeError) { - * return null; - * } - * throw e; - * } - * }; - * ``` - * - * See https://github.com/angular/angular.js/pull/14221 for more information. - */ -function toJson(obj, pretty) { - if (isUndefined(obj)) return undefined; - if (!isNumber(pretty)) { - pretty = pretty ? 2 : null; - } - return JSON.stringify(obj, toJsonReplacer, pretty); -} - - -/** - * @ngdoc function - * @name angular.fromJson - * @module ng - * @kind function - * - * @description - * Deserializes a JSON string. - * - * @param {string} json JSON string to deserialize. - * @returns {Object|Array|string|number} Deserialized JSON string. - */ -function fromJson(json) { - return isString(json) - ? JSON.parse(json) - : json; -} - - -var ALL_COLONS = /:/g; -function timezoneToOffset(timezone, fallback) { - // Support: IE 9-11 only, Edge 13-14+ - // IE/Edge do not "understand" colon (`:`) in timezone - timezone = timezone.replace(ALL_COLONS, ''); - var requestedTimezoneOffset = Date.parse('Jan 01, 1970 00:00:00 ' + timezone) / 60000; - return isNumberNaN(requestedTimezoneOffset) ? fallback : requestedTimezoneOffset; -} - - -function addDateMinutes(date, minutes) { - date = new Date(date.getTime()); - date.setMinutes(date.getMinutes() + minutes); - return date; -} - - -function convertTimezoneToLocal(date, timezone, reverse) { - reverse = reverse ? -1 : 1; - var dateTimezoneOffset = date.getTimezoneOffset(); - var timezoneOffset = timezoneToOffset(timezone, dateTimezoneOffset); - return addDateMinutes(date, reverse * (timezoneOffset - dateTimezoneOffset)); -} - - -/** - * @returns {string} Returns the string representation of the element. - */ -function startingTag(element) { - element = jqLite(element).clone(); - try { - // turns out IE does not let you set .html() on elements which - // are not allowed to have children. So we just ignore it. - element.empty(); - } catch (e) { /* empty */ } - var elemHtml = jqLite('
').append(element).html(); - try { - return element[0].nodeType === NODE_TYPE_TEXT ? lowercase(elemHtml) : - elemHtml. - match(/^(<[^>]+>)/)[1]. - replace(/^<([\w-]+)/, function(match, nodeName) {return '<' + lowercase(nodeName);}); - } catch (e) { - return lowercase(elemHtml); - } - -} - - -///////////////////////////////////////////////// - -/** - * Tries to decode the URI component without throwing an exception. - * - * @private - * @param str value potential URI component to check. - * @returns {boolean} True if `value` can be decoded - * with the decodeURIComponent function. - */ -function tryDecodeURIComponent(value) { - try { - return decodeURIComponent(value); - } catch (e) { - // Ignore any invalid uri component. - } -} - - -/** - * Parses an escaped url query string into key-value pairs. - * @returns {Object.} - */ -function parseKeyValue(/**string*/keyValue) { - var obj = {}; - forEach((keyValue || '').split('&'), function(keyValue) { - var splitPoint, key, val; - if (keyValue) { - key = keyValue = keyValue.replace(/\+/g,'%20'); - splitPoint = keyValue.indexOf('='); - if (splitPoint !== -1) { - key = keyValue.substring(0, splitPoint); - val = keyValue.substring(splitPoint + 1); - } - key = tryDecodeURIComponent(key); - if (isDefined(key)) { - val = isDefined(val) ? tryDecodeURIComponent(val) : true; - if (!hasOwnProperty.call(obj, key)) { - obj[key] = val; - } else if (isArray(obj[key])) { - obj[key].push(val); - } else { - obj[key] = [obj[key],val]; - } - } - } - }); - return obj; -} - -function toKeyValue(obj) { - var parts = []; - forEach(obj, function(value, key) { - if (isArray(value)) { - forEach(value, function(arrayValue) { - parts.push(encodeUriQuery(key, true) + - (arrayValue === true ? '' : '=' + encodeUriQuery(arrayValue, true))); - }); - } else { - parts.push(encodeUriQuery(key, true) + - (value === true ? '' : '=' + encodeUriQuery(value, true))); - } - }); - return parts.length ? parts.join('&') : ''; -} - - -/** - * We need our custom method because encodeURIComponent is too aggressive and doesn't follow - * http://www.ietf.org/rfc/rfc3986.txt with regards to the character set (pchar) allowed in path - * segments: - * segment = *pchar - * pchar = unreserved / pct-encoded / sub-delims / ":" / "@" - * pct-encoded = "%" HEXDIG HEXDIG - * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" - * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" - * / "*" / "+" / "," / ";" / "=" - */ -function encodeUriSegment(val) { - return encodeUriQuery(val, true). - replace(/%26/gi, '&'). - replace(/%3D/gi, '='). - replace(/%2B/gi, '+'); -} - - -/** - * This method is intended for encoding *key* or *value* parts of query component. We need a custom - * method because encodeURIComponent is too aggressive and encodes stuff that doesn't have to be - * encoded per http://tools.ietf.org/html/rfc3986: - * query = *( pchar / "/" / "?" ) - * pchar = unreserved / pct-encoded / sub-delims / ":" / "@" - * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" - * pct-encoded = "%" HEXDIG HEXDIG - * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" - * / "*" / "+" / "," / ";" / "=" - */ -function encodeUriQuery(val, pctEncodeSpaces) { - return encodeURIComponent(val). - replace(/%40/gi, '@'). - replace(/%3A/gi, ':'). - replace(/%24/g, '$'). - replace(/%2C/gi, ','). - replace(/%3B/gi, ';'). - replace(/%20/g, (pctEncodeSpaces ? '%20' : '+')); -} - -var ngAttrPrefixes = ['ng-', 'data-ng-', 'ng:', 'x-ng-']; - -function getNgAttribute(element, ngAttr) { - var attr, i, ii = ngAttrPrefixes.length; - for (i = 0; i < ii; ++i) { - attr = ngAttrPrefixes[i] + ngAttr; - if (isString(attr = element.getAttribute(attr))) { - return attr; - } - } - return null; -} - -function allowAutoBootstrap(document) { - if (!document.currentScript) { - return true; - } - var src = document.currentScript.getAttribute('src'); - var link = document.createElement('a'); - link.href = src; - if (document.location.origin === link.origin) { - // Same-origin resources are always allowed, even for non-whitelisted schemes. - return true; - } - // Disabled bootstrapping unless angular.js was loaded from a known scheme used on the web. - // This is to prevent angular.js bundled with browser extensions from being used to bypass the - // content security policy in web pages and other browser extensions. - switch (link.protocol) { - case 'http:': - case 'https:': - case 'ftp:': - case 'blob:': - case 'file:': - case 'data:': - return true; - default: - return false; - } -} - -// Cached as it has to run during loading so that document.currentScript is available. -var isAutoBootstrapAllowed = allowAutoBootstrap(window.document); - -/** - * @ngdoc directive - * @name ngApp - * @module ng - * - * @element ANY - * @param {angular.Module} ngApp an optional application - * {@link angular.module module} name to load. - * @param {boolean=} ngStrictDi if this attribute is present on the app element, the injector will be - * created in "strict-di" mode. This means that the application will fail to invoke functions which - * do not use explicit function annotation (and are thus unsuitable for minification), as described - * in {@link guide/di the Dependency Injection guide}, and useful debugging info will assist in - * tracking down the root of these bugs. - * - * @description - * - * Use this directive to **auto-bootstrap** an AngularJS application. The `ngApp` directive - * designates the **root element** of the application and is typically placed near the root element - * of the page - e.g. on the `` or `` tags. - * - * There are a few things to keep in mind when using `ngApp`: - * - only one AngularJS application can be auto-bootstrapped per HTML document. The first `ngApp` - * found in the document will be used to define the root element to auto-bootstrap as an - * application. To run multiple applications in an HTML document you must manually bootstrap them using - * {@link angular.bootstrap} instead. - * - AngularJS applications cannot be nested within each other. - * - Do not use a directive that uses {@link ng.$compile#transclusion transclusion} on the same element as `ngApp`. - * This includes directives such as {@link ng.ngIf `ngIf`}, {@link ng.ngInclude `ngInclude`} and - * {@link ngRoute.ngView `ngView`}. - * Doing this misplaces the app {@link ng.$rootElement `$rootElement`} and the app's {@link auto.$injector injector}, - * causing animations to stop working and making the injector inaccessible from outside the app. - * - * You can specify an **AngularJS module** to be used as the root module for the application. This - * module will be loaded into the {@link auto.$injector} when the application is bootstrapped. It - * should contain the application code needed or have dependencies on other modules that will - * contain the code. See {@link angular.module} for more information. - * - * In the example below if the `ngApp` directive were not placed on the `html` element then the - * document would not be compiled, the `AppController` would not be instantiated and the `{{ a+b }}` - * would not be resolved to `3`. - * - * `ngApp` is the easiest, and most common way to bootstrap an application. - * - - -
- I can add: {{a}} + {{b}} = {{ a+b }} -
- - - angular.module('ngAppDemo', []).controller('ngAppDemoController', function($scope) { - $scope.a = 1; - $scope.b = 2; - }); - - - * - * Using `ngStrictDi`, you would see something like this: - * - - -
-
- I can add: {{a}} + {{b}} = {{ a+b }} - -

This renders because the controller does not fail to - instantiate, by using explicit annotation style (see - script.js for details) -

-
- -
- Name:
- Hello, {{name}}! - -

This renders because the controller does not fail to - instantiate, by using explicit annotation style - (see script.js for details) -

-
- -
- I can add: {{a}} + {{b}} = {{ a+b }} - -

The controller could not be instantiated, due to relying - on automatic function annotations (which are disabled in - strict mode). As such, the content of this section is not - interpolated, and there should be an error in your web console. -

-
-
- - - angular.module('ngAppStrictDemo', []) - // BadController will fail to instantiate, due to relying on automatic function annotation, - // rather than an explicit annotation - .controller('BadController', function($scope) { - $scope.a = 1; - $scope.b = 2; - }) - // Unlike BadController, GoodController1 and GoodController2 will not fail to be instantiated, - // due to using explicit annotations using the array style and $inject property, respectively. - .controller('GoodController1', ['$scope', function($scope) { - $scope.a = 1; - $scope.b = 2; - }]) - .controller('GoodController2', GoodController2); - function GoodController2($scope) { - $scope.name = 'World'; - } - GoodController2.$inject = ['$scope']; - - - div[ng-controller] { - margin-bottom: 1em; - -webkit-border-radius: 4px; - border-radius: 4px; - border: 1px solid; - padding: .5em; - } - div[ng-controller^=Good] { - border-color: #d6e9c6; - background-color: #dff0d8; - color: #3c763d; - } - div[ng-controller^=Bad] { - border-color: #ebccd1; - background-color: #f2dede; - color: #a94442; - margin-bottom: 0; - } - - - */ -function angularInit(element, bootstrap) { - var appElement, - module, - config = {}; - - // The element `element` has priority over any other element. - forEach(ngAttrPrefixes, function(prefix) { - var name = prefix + 'app'; - - if (!appElement && element.hasAttribute && element.hasAttribute(name)) { - appElement = element; - module = element.getAttribute(name); - } - }); - forEach(ngAttrPrefixes, function(prefix) { - var name = prefix + 'app'; - var candidate; - - if (!appElement && (candidate = element.querySelector('[' + name.replace(':', '\\:') + ']'))) { - appElement = candidate; - module = candidate.getAttribute(name); - } - }); - if (appElement) { - if (!isAutoBootstrapAllowed) { - window.console.error('Angular: disabling automatic bootstrap. - * - * - * - * ``` - * - * @param {DOMElement} element DOM element which is the root of angular application. - * @param {Array=} modules an array of modules to load into the application. - * Each item in the array should be the name of a predefined module or a (DI annotated) - * function that will be invoked by the injector as a `config` block. - * See: {@link angular.module modules} - * @param {Object=} config an object for defining configuration options for the application. The - * following keys are supported: - * - * * `strictDi` - disable automatic function annotation for the application. This is meant to - * assist in finding bugs which break minified code. Defaults to `false`. - * - * @returns {auto.$injector} Returns the newly created injector for this app. - */ -function bootstrap(element, modules, config) { - if (!isObject(config)) config = {}; - var defaultConfig = { - strictDi: false - }; - config = extend(defaultConfig, config); - var doBootstrap = function() { - element = jqLite(element); - - if (element.injector()) { - var tag = (element[0] === window.document) ? 'document' : startingTag(element); - // Encode angle brackets to prevent input from being sanitized to empty string #8683. - throw ngMinErr( - 'btstrpd', - 'App already bootstrapped with this element \'{0}\'', - tag.replace(//,'>')); - } - - modules = modules || []; - modules.unshift(['$provide', function($provide) { - $provide.value('$rootElement', element); - }]); - - if (config.debugInfoEnabled) { - // Pushing so that this overrides `debugInfoEnabled` setting defined in user's `modules`. - modules.push(['$compileProvider', function($compileProvider) { - $compileProvider.debugInfoEnabled(true); - }]); - } - - modules.unshift('ng'); - var injector = createInjector(modules, config.strictDi); - injector.invoke(['$rootScope', '$rootElement', '$compile', '$injector', - function bootstrapApply(scope, element, compile, injector) { - scope.$apply(function() { - element.data('$injector', injector); - compile(element)(scope); - }); - }] - ); - return injector; - }; - - var NG_ENABLE_DEBUG_INFO = /^NG_ENABLE_DEBUG_INFO!/; - var NG_DEFER_BOOTSTRAP = /^NG_DEFER_BOOTSTRAP!/; - - if (window && NG_ENABLE_DEBUG_INFO.test(window.name)) { - config.debugInfoEnabled = true; - window.name = window.name.replace(NG_ENABLE_DEBUG_INFO, ''); - } - - if (window && !NG_DEFER_BOOTSTRAP.test(window.name)) { - return doBootstrap(); - } - - window.name = window.name.replace(NG_DEFER_BOOTSTRAP, ''); - angular.resumeBootstrap = function(extraModules) { - forEach(extraModules, function(module) { - modules.push(module); - }); - return doBootstrap(); - }; - - if (isFunction(angular.resumeDeferredBootstrap)) { - angular.resumeDeferredBootstrap(); - } -} - -/** - * @ngdoc function - * @name angular.reloadWithDebugInfo - * @module ng - * @description - * Use this function to reload the current application with debug information turned on. - * This takes precedence over a call to `$compileProvider.debugInfoEnabled(false)`. - * - * See {@link ng.$compileProvider#debugInfoEnabled} for more. - */ -function reloadWithDebugInfo() { - window.name = 'NG_ENABLE_DEBUG_INFO!' + window.name; - window.location.reload(); -} - -/** - * @name angular.getTestability - * @module ng - * @description - * Get the testability service for the instance of Angular on the given - * element. - * @param {DOMElement} element DOM element which is the root of angular application. - */ -function getTestability(rootElement) { - var injector = angular.element(rootElement).injector(); - if (!injector) { - throw ngMinErr('test', - 'no injector found for element argument to getTestability'); - } - return injector.get('$$testability'); -} - -var SNAKE_CASE_REGEXP = /[A-Z]/g; -function snake_case(name, separator) { - separator = separator || '_'; - return name.replace(SNAKE_CASE_REGEXP, function(letter, pos) { - return (pos ? separator : '') + letter.toLowerCase(); - }); -} - -var bindJQueryFired = false; -function bindJQuery() { - var originalCleanData; - - if (bindJQueryFired) { - return; - } - - // bind to jQuery if present; - var jqName = jq(); - jQuery = isUndefined(jqName) ? window.jQuery : // use jQuery (if present) - !jqName ? undefined : // use jqLite - window[jqName]; // use jQuery specified by `ngJq` - - // Use jQuery if it exists with proper functionality, otherwise default to us. - // Angular 1.2+ requires jQuery 1.7+ for on()/off() support. - // Angular 1.3+ technically requires at least jQuery 2.1+ but it may work with older - // versions. It will not work for sure with jQuery <1.7, though. - if (jQuery && jQuery.fn.on) { - jqLite = jQuery; - extend(jQuery.fn, { - scope: JQLitePrototype.scope, - isolateScope: JQLitePrototype.isolateScope, - controller: JQLitePrototype.controller, - injector: JQLitePrototype.injector, - inheritedData: JQLitePrototype.inheritedData - }); - - // All nodes removed from the DOM via various jQuery APIs like .remove() - // are passed through jQuery.cleanData. Monkey-patch this method to fire - // the $destroy event on all removed nodes. - originalCleanData = jQuery.cleanData; - jQuery.cleanData = function(elems) { - var events; - for (var i = 0, elem; (elem = elems[i]) != null; i++) { - events = jQuery._data(elem, 'events'); - if (events && events.$destroy) { - jQuery(elem).triggerHandler('$destroy'); - } - } - originalCleanData(elems); - }; - } else { - jqLite = JQLite; - } - - angular.element = jqLite; - - // Prevent double-proxying. - bindJQueryFired = true; -} - -/** - * throw error if the argument is falsy. - */ -function assertArg(arg, name, reason) { - if (!arg) { - throw ngMinErr('areq', 'Argument \'{0}\' is {1}', (name || '?'), (reason || 'required')); - } - return arg; -} - -function assertArgFn(arg, name, acceptArrayAnnotation) { - if (acceptArrayAnnotation && isArray(arg)) { - arg = arg[arg.length - 1]; - } - - assertArg(isFunction(arg), name, 'not a function, got ' + - (arg && typeof arg === 'object' ? arg.constructor.name || 'Object' : typeof arg)); - return arg; -} - -/** - * throw error if the name given is hasOwnProperty - * @param {String} name the name to test - * @param {String} context the context in which the name is used, such as module or directive - */ -function assertNotHasOwnProperty(name, context) { - if (name === 'hasOwnProperty') { - throw ngMinErr('badname', 'hasOwnProperty is not a valid {0} name', context); - } -} - -/** - * Return the value accessible from the object by path. Any undefined traversals are ignored - * @param {Object} obj starting object - * @param {String} path path to traverse - * @param {boolean} [bindFnToScope=true] - * @returns {Object} value as accessible by path - */ -//TODO(misko): this function needs to be removed -function getter(obj, path, bindFnToScope) { - if (!path) return obj; - var keys = path.split('.'); - var key; - var lastInstance = obj; - var len = keys.length; - - for (var i = 0; i < len; i++) { - key = keys[i]; - if (obj) { - obj = (lastInstance = obj)[key]; - } - } - if (!bindFnToScope && isFunction(obj)) { - return bind(lastInstance, obj); - } - return obj; -} - -/** - * Return the DOM siblings between the first and last node in the given array. - * @param {Array} array like object - * @returns {Array} the inputted object or a jqLite collection containing the nodes - */ -function getBlockNodes(nodes) { - // TODO(perf): update `nodes` instead of creating a new object? - var node = nodes[0]; - var endNode = nodes[nodes.length - 1]; - var blockNodes; - - for (var i = 1; node !== endNode && (node = node.nextSibling); i++) { - if (blockNodes || nodes[i] !== node) { - if (!blockNodes) { - blockNodes = jqLite(slice.call(nodes, 0, i)); - } - blockNodes.push(node); - } - } - - return blockNodes || nodes; -} - - -/** - * Creates a new object without a prototype. This object is useful for lookup without having to - * guard against prototypically inherited properties via hasOwnProperty. - * - * Related micro-benchmarks: - * - http://jsperf.com/object-create2 - * - http://jsperf.com/proto-map-lookup/2 - * - http://jsperf.com/for-in-vs-object-keys2 - * - * @returns {Object} - */ -function createMap() { - return Object.create(null); -} - -function stringify(value) { - if (value == null) { // null || undefined - return ''; - } - switch (typeof value) { - case 'string': - break; - case 'number': - value = '' + value; - break; - default: - if (hasCustomToString(value) && !isArray(value) && !isDate(value)) { - value = value.toString(); - } else { - value = toJson(value); - } - } - - return value; -} - -var NODE_TYPE_ELEMENT = 1; -var NODE_TYPE_ATTRIBUTE = 2; -var NODE_TYPE_TEXT = 3; -var NODE_TYPE_COMMENT = 8; -var NODE_TYPE_DOCUMENT = 9; -var NODE_TYPE_DOCUMENT_FRAGMENT = 11; - -/** - * @ngdoc type - * @name angular.Module - * @module ng - * @description - * - * Interface for configuring angular {@link angular.module modules}. - */ - -function setupModuleLoader(window) { - - var $injectorMinErr = minErr('$injector'); - var ngMinErr = minErr('ng'); - - function ensure(obj, name, factory) { - return obj[name] || (obj[name] = factory()); - } - - var angular = ensure(window, 'angular', Object); - - // We need to expose `angular.$$minErr` to modules such as `ngResource` that reference it during bootstrap - angular.$$minErr = angular.$$minErr || minErr; - - return ensure(angular, 'module', function() { - /** @type {Object.} */ - var modules = {}; - - /** - * @ngdoc function - * @name angular.module - * @module ng - * @description - * - * The `angular.module` is a global place for creating, registering and retrieving Angular - * modules. - * All modules (angular core or 3rd party) that should be available to an application must be - * registered using this mechanism. - * - * Passing one argument retrieves an existing {@link angular.Module}, - * whereas passing more than one argument creates a new {@link angular.Module} - * - * - * # Module - * - * A module is a collection of services, directives, controllers, filters, and configuration information. - * `angular.module` is used to configure the {@link auto.$injector $injector}. - * - * ```js - * // Create a new module - * var myModule = angular.module('myModule', []); - * - * // register a new service - * myModule.value('appName', 'MyCoolApp'); - * - * // configure existing services inside initialization blocks. - * myModule.config(['$locationProvider', function($locationProvider) { - * // Configure existing providers - * $locationProvider.hashPrefix('!'); - * }]); - * ``` - * - * Then you can create an injector and load your modules like this: - * - * ```js - * var injector = angular.injector(['ng', 'myModule']) - * ``` - * - * However it's more likely that you'll just use - * {@link ng.directive:ngApp ngApp} or - * {@link angular.bootstrap} to simplify this process for you. - * - * @param {!string} name The name of the module to create or retrieve. - * @param {!Array.=} requires If specified then new module is being created. If - * unspecified then the module is being retrieved for further configuration. - * @param {Function=} configFn Optional configuration function for the module. Same as - * {@link angular.Module#config Module#config()}. - * @returns {angular.Module} new module with the {@link angular.Module} api. - */ - return function module(name, requires, configFn) { - var assertNotHasOwnProperty = function(name, context) { - if (name === 'hasOwnProperty') { - throw ngMinErr('badname', 'hasOwnProperty is not a valid {0} name', context); - } - }; - - assertNotHasOwnProperty(name, 'module'); - if (requires && modules.hasOwnProperty(name)) { - modules[name] = null; - } - return ensure(modules, name, function() { - if (!requires) { - throw $injectorMinErr('nomod', 'Module \'{0}\' is not available! You either misspelled ' + - 'the module name or forgot to load it. If registering a module ensure that you ' + - 'specify the dependencies as the second argument.', name); - } - - /** @type {!Array.>} */ - var invokeQueue = []; - - /** @type {!Array.} */ - var configBlocks = []; - - /** @type {!Array.} */ - var runBlocks = []; - - var config = invokeLater('$injector', 'invoke', 'push', configBlocks); - - /** @type {angular.Module} */ - var moduleInstance = { - // Private state - _invokeQueue: invokeQueue, - _configBlocks: configBlocks, - _runBlocks: runBlocks, - - /** - * @ngdoc property - * @name angular.Module#requires - * @module ng - * - * @description - * Holds the list of modules which the injector will load before the current module is - * loaded. - */ - requires: requires, - - /** - * @ngdoc property - * @name angular.Module#name - * @module ng - * - * @description - * Name of the module. - */ - name: name, - - - /** - * @ngdoc method - * @name angular.Module#provider - * @module ng - * @param {string} name service name - * @param {Function} providerType Construction function for creating new instance of the - * service. - * @description - * See {@link auto.$provide#provider $provide.provider()}. - */ - provider: invokeLaterAndSetModuleName('$provide', 'provider'), - - /** - * @ngdoc method - * @name angular.Module#factory - * @module ng - * @param {string} name service name - * @param {Function} providerFunction Function for creating new instance of the service. - * @description - * See {@link auto.$provide#factory $provide.factory()}. - */ - factory: invokeLaterAndSetModuleName('$provide', 'factory'), - - /** - * @ngdoc method - * @name angular.Module#service - * @module ng - * @param {string} name service name - * @param {Function} constructor A constructor function that will be instantiated. - * @description - * See {@link auto.$provide#service $provide.service()}. - */ - service: invokeLaterAndSetModuleName('$provide', 'service'), - - /** - * @ngdoc method - * @name angular.Module#value - * @module ng - * @param {string} name service name - * @param {*} object Service instance object. - * @description - * See {@link auto.$provide#value $provide.value()}. - */ - value: invokeLater('$provide', 'value'), - - /** - * @ngdoc method - * @name angular.Module#constant - * @module ng - * @param {string} name constant name - * @param {*} object Constant value. - * @description - * Because the constants are fixed, they get applied before other provide methods. - * See {@link auto.$provide#constant $provide.constant()}. - */ - constant: invokeLater('$provide', 'constant', 'unshift'), - - /** - * @ngdoc method - * @name angular.Module#decorator - * @module ng - * @param {string} name The name of the service to decorate. - * @param {Function} decorFn This function will be invoked when the service needs to be - * instantiated and should return the decorated service instance. - * @description - * See {@link auto.$provide#decorator $provide.decorator()}. - */ - decorator: invokeLaterAndSetModuleName('$provide', 'decorator', configBlocks), - - /** - * @ngdoc method - * @name angular.Module#animation - * @module ng - * @param {string} name animation name - * @param {Function} animationFactory Factory function for creating new instance of an - * animation. - * @description - * - * **NOTE**: animations take effect only if the **ngAnimate** module is loaded. - * - * - * Defines an animation hook that can be later used with - * {@link $animate $animate} service and directives that use this service. - * - * ```js - * module.animation('.animation-name', function($inject1, $inject2) { - * return { - * eventName : function(element, done) { - * //code to run the animation - * //once complete, then run done() - * return function cancellationFunction(element) { - * //code to cancel the animation - * } - * } - * } - * }) - * ``` - * - * See {@link ng.$animateProvider#register $animateProvider.register()} and - * {@link ngAnimate ngAnimate module} for more information. - */ - animation: invokeLaterAndSetModuleName('$animateProvider', 'register'), - - /** - * @ngdoc method - * @name angular.Module#filter - * @module ng - * @param {string} name Filter name - this must be a valid angular expression identifier - * @param {Function} filterFactory Factory function for creating new instance of filter. - * @description - * See {@link ng.$filterProvider#register $filterProvider.register()}. - * - *
- * **Note:** Filter names must be valid angular {@link expression} identifiers, such as `uppercase` or `orderBy`. - * Names with special characters, such as hyphens and dots, are not allowed. If you wish to namespace - * your filters, then you can use capitalization (`myappSubsectionFilterx`) or underscores - * (`myapp_subsection_filterx`). - *
- */ - filter: invokeLaterAndSetModuleName('$filterProvider', 'register'), - - /** - * @ngdoc method - * @name angular.Module#controller - * @module ng - * @param {string|Object} name Controller name, or an object map of controllers where the - * keys are the names and the values are the constructors. - * @param {Function} constructor Controller constructor function. - * @description - * See {@link ng.$controllerProvider#register $controllerProvider.register()}. - */ - controller: invokeLaterAndSetModuleName('$controllerProvider', 'register'), - - /** - * @ngdoc method - * @name angular.Module#directive - * @module ng - * @param {string|Object} name Directive name, or an object map of directives where the - * keys are the names and the values are the factories. - * @param {Function} directiveFactory Factory function for creating new instance of - * directives. - * @description - * See {@link ng.$compileProvider#directive $compileProvider.directive()}. - */ - directive: invokeLaterAndSetModuleName('$compileProvider', 'directive'), - - /** - * @ngdoc method - * @name angular.Module#component - * @module ng - * @param {string} name Name of the component in camel-case (i.e. myComp which will match as my-comp) - * @param {Object} options Component definition object (a simplified - * {@link ng.$compile#directive-definition-object directive definition object}) - * - * @description - * See {@link ng.$compileProvider#component $compileProvider.component()}. - */ - component: invokeLaterAndSetModuleName('$compileProvider', 'component'), - - /** - * @ngdoc method - * @name angular.Module#config - * @module ng - * @param {Function} configFn Execute this function on module load. Useful for service - * configuration. - * @description - * Use this method to register work which needs to be performed on module loading. - * For more about how to configure services, see - * {@link providers#provider-recipe Provider Recipe}. - */ - config: config, - - /** - * @ngdoc method - * @name angular.Module#run - * @module ng - * @param {Function} initializationFn Execute this function after injector creation. - * Useful for application initialization. - * @description - * Use this method to register work which should be performed when the injector is done - * loading all modules. - */ - run: function(block) { - runBlocks.push(block); - return this; - } - }; - - if (configFn) { - config(configFn); - } - - return moduleInstance; - - /** - * @param {string} provider - * @param {string} method - * @param {String=} insertMethod - * @returns {angular.Module} - */ - function invokeLater(provider, method, insertMethod, queue) { - if (!queue) queue = invokeQueue; - return function() { - queue[insertMethod || 'push']([provider, method, arguments]); - return moduleInstance; - }; - } - - /** - * @param {string} provider - * @param {string} method - * @returns {angular.Module} - */ - function invokeLaterAndSetModuleName(provider, method, queue) { - if (!queue) queue = invokeQueue; - return function(recipeName, factoryFunction) { - if (factoryFunction && isFunction(factoryFunction)) factoryFunction.$$moduleName = name; - queue.push([provider, method, arguments]); - return moduleInstance; - }; - } - }); - }; - }); - -} - -/* global shallowCopy: true */ - -/** - * Creates a shallow copy of an object, an array or a primitive. - * - * Assumes that there are no proto properties for objects. - */ -function shallowCopy(src, dst) { - if (isArray(src)) { - dst = dst || []; - - for (var i = 0, ii = src.length; i < ii; i++) { - dst[i] = src[i]; - } - } else if (isObject(src)) { - dst = dst || {}; - - for (var key in src) { - if (!(key.charAt(0) === '$' && key.charAt(1) === '$')) { - dst[key] = src[key]; - } - } - } - - return dst || src; -} - -/* global toDebugString: true */ - -function serializeObject(obj) { - var seen = []; - - return JSON.stringify(obj, function(key, val) { - val = toJsonReplacer(key, val); - if (isObject(val)) { - - if (seen.indexOf(val) >= 0) return '...'; - - seen.push(val); - } - return val; - }); -} - -function toDebugString(obj) { - if (typeof obj === 'function') { - return obj.toString().replace(/ \{[\s\S]*$/, ''); - } else if (isUndefined(obj)) { - return 'undefined'; - } else if (typeof obj !== 'string') { - return serializeObject(obj); - } - return obj; -} - -/* global angularModule: true, - version: true, - - $CompileProvider, - - htmlAnchorDirective, - inputDirective, - inputDirective, - formDirective, - scriptDirective, - selectDirective, - optionDirective, - ngBindDirective, - ngBindHtmlDirective, - ngBindTemplateDirective, - ngClassDirective, - ngClassEvenDirective, - ngClassOddDirective, - ngCloakDirective, - ngControllerDirective, - ngFormDirective, - ngHideDirective, - ngIfDirective, - ngIncludeDirective, - ngIncludeFillContentDirective, - ngInitDirective, - ngNonBindableDirective, - ngPluralizeDirective, - ngRepeatDirective, - ngShowDirective, - ngStyleDirective, - ngSwitchDirective, - ngSwitchWhenDirective, - ngSwitchDefaultDirective, - ngOptionsDirective, - ngTranscludeDirective, - ngModelDirective, - ngListDirective, - ngChangeDirective, - patternDirective, - patternDirective, - requiredDirective, - requiredDirective, - minlengthDirective, - minlengthDirective, - maxlengthDirective, - maxlengthDirective, - ngValueDirective, - ngModelOptionsDirective, - ngAttributeAliasDirectives, - ngEventDirectives, - - $AnchorScrollProvider, - $AnimateProvider, - $CoreAnimateCssProvider, - $$CoreAnimateJsProvider, - $$CoreAnimateQueueProvider, - $$AnimateRunnerFactoryProvider, - $$AnimateAsyncRunFactoryProvider, - $BrowserProvider, - $CacheFactoryProvider, - $ControllerProvider, - $DateProvider, - $DocumentProvider, - $$IsDocumentHiddenProvider, - $ExceptionHandlerProvider, - $FilterProvider, - $$ForceReflowProvider, - $InterpolateProvider, - $IntervalProvider, - $$HashMapProvider, - $HttpProvider, - $HttpParamSerializerProvider, - $HttpParamSerializerJQLikeProvider, - $HttpBackendProvider, - $xhrFactoryProvider, - $jsonpCallbacksProvider, - $LocationProvider, - $LogProvider, - $ParseProvider, - $RootScopeProvider, - $QProvider, - $$QProvider, - $$SanitizeUriProvider, - $SceProvider, - $SceDelegateProvider, - $SnifferProvider, - $TemplateCacheProvider, - $TemplateRequestProvider, - $$TestabilityProvider, - $TimeoutProvider, - $$RAFProvider, - $WindowProvider, - $$jqLiteProvider, - $$CookieReaderProvider -*/ - - -/** - * @ngdoc object - * @name angular.version - * @module ng - * @description - * An object that contains information about the current AngularJS version. - * - * This object has the following properties: - * - * - `full` – `{string}` – Full version string, such as "0.9.18". - * - `major` – `{number}` – Major version number, such as "0". - * - `minor` – `{number}` – Minor version number, such as "9". - * - `dot` – `{number}` – Dot version number, such as "18". - * - `codeName` – `{string}` – Code name of the release, such as "jiggling-armfat". - */ -var version = { - // These placeholder strings will be replaced by grunt's `build` task. - // They need to be double- or single-quoted. - full: '1.6.0', - major: 1, - minor: 6, - dot: 0, - codeName: 'rainbow-tsunami' -}; - - -function publishExternalAPI(angular) { - extend(angular, { - 'bootstrap': bootstrap, - 'copy': copy, - 'extend': extend, - 'merge': merge, - 'equals': equals, - 'element': jqLite, - 'forEach': forEach, - 'injector': createInjector, - 'noop': noop, - 'bind': bind, - 'toJson': toJson, - 'fromJson': fromJson, - 'identity': identity, - 'isUndefined': isUndefined, - 'isDefined': isDefined, - 'isString': isString, - 'isFunction': isFunction, - 'isObject': isObject, - 'isNumber': isNumber, - 'isElement': isElement, - 'isArray': isArray, - 'version': version, - 'isDate': isDate, - 'lowercase': lowercase, - 'uppercase': uppercase, - 'callbacks': {$$counter: 0}, - 'getTestability': getTestability, - 'reloadWithDebugInfo': reloadWithDebugInfo, - '$$minErr': minErr, - '$$csp': csp, - '$$encodeUriSegment': encodeUriSegment, - '$$encodeUriQuery': encodeUriQuery, - '$$stringify': stringify - }); - - angularModule = setupModuleLoader(window); - - angularModule('ng', ['ngLocale'], ['$provide', - function ngModule($provide) { - // $$sanitizeUriProvider needs to be before $compileProvider as it is used by it. - $provide.provider({ - $$sanitizeUri: $$SanitizeUriProvider - }); - $provide.provider('$compile', $CompileProvider). - directive({ - a: htmlAnchorDirective, - input: inputDirective, - textarea: inputDirective, - form: formDirective, - script: scriptDirective, - select: selectDirective, - option: optionDirective, - ngBind: ngBindDirective, - ngBindHtml: ngBindHtmlDirective, - ngBindTemplate: ngBindTemplateDirective, - ngClass: ngClassDirective, - ngClassEven: ngClassEvenDirective, - ngClassOdd: ngClassOddDirective, - ngCloak: ngCloakDirective, - ngController: ngControllerDirective, - ngForm: ngFormDirective, - ngHide: ngHideDirective, - ngIf: ngIfDirective, - ngInclude: ngIncludeDirective, - ngInit: ngInitDirective, - ngNonBindable: ngNonBindableDirective, - ngPluralize: ngPluralizeDirective, - ngRepeat: ngRepeatDirective, - ngShow: ngShowDirective, - ngStyle: ngStyleDirective, - ngSwitch: ngSwitchDirective, - ngSwitchWhen: ngSwitchWhenDirective, - ngSwitchDefault: ngSwitchDefaultDirective, - ngOptions: ngOptionsDirective, - ngTransclude: ngTranscludeDirective, - ngModel: ngModelDirective, - ngList: ngListDirective, - ngChange: ngChangeDirective, - pattern: patternDirective, - ngPattern: patternDirective, - required: requiredDirective, - ngRequired: requiredDirective, - minlength: minlengthDirective, - ngMinlength: minlengthDirective, - maxlength: maxlengthDirective, - ngMaxlength: maxlengthDirective, - ngValue: ngValueDirective, - ngModelOptions: ngModelOptionsDirective - }). - directive({ - ngInclude: ngIncludeFillContentDirective - }). - directive(ngAttributeAliasDirectives). - directive(ngEventDirectives); - $provide.provider({ - $anchorScroll: $AnchorScrollProvider, - $animate: $AnimateProvider, - $animateCss: $CoreAnimateCssProvider, - $$animateJs: $$CoreAnimateJsProvider, - $$animateQueue: $$CoreAnimateQueueProvider, - $$AnimateRunner: $$AnimateRunnerFactoryProvider, - $$animateAsyncRun: $$AnimateAsyncRunFactoryProvider, - $browser: $BrowserProvider, - $cacheFactory: $CacheFactoryProvider, - $controller: $ControllerProvider, - $document: $DocumentProvider, - $$isDocumentHidden: $$IsDocumentHiddenProvider, - $exceptionHandler: $ExceptionHandlerProvider, - $filter: $FilterProvider, - $$forceReflow: $$ForceReflowProvider, - $interpolate: $InterpolateProvider, - $interval: $IntervalProvider, - $http: $HttpProvider, - $httpParamSerializer: $HttpParamSerializerProvider, - $httpParamSerializerJQLike: $HttpParamSerializerJQLikeProvider, - $httpBackend: $HttpBackendProvider, - $xhrFactory: $xhrFactoryProvider, - $jsonpCallbacks: $jsonpCallbacksProvider, - $location: $LocationProvider, - $log: $LogProvider, - $parse: $ParseProvider, - $rootScope: $RootScopeProvider, - $q: $QProvider, - $$q: $$QProvider, - $sce: $SceProvider, - $sceDelegate: $SceDelegateProvider, - $sniffer: $SnifferProvider, - $templateCache: $TemplateCacheProvider, - $templateRequest: $TemplateRequestProvider, - $$testability: $$TestabilityProvider, - $timeout: $TimeoutProvider, - $window: $WindowProvider, - $$rAF: $$RAFProvider, - $$jqLite: $$jqLiteProvider, - $$HashMap: $$HashMapProvider, - $$cookieReader: $$CookieReaderProvider - }); - } - ]); -} - -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - * Any commits to this file should be reviewed with security in mind. * - * Changes to this file can potentially create security vulnerabilities. * - * An approval from 2 Core members with history of modifying * - * this file is required. * - * * - * Does the change somehow allow for arbitrary javascript to be executed? * - * Or allows for someone to change the prototype of built-in objects? * - * Or gives undesired access to variables likes document or window? * - * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -/* global - JQLitePrototype: true, - BOOLEAN_ATTR: true, - ALIASED_ATTR: true -*/ - -////////////////////////////////// -//JQLite -////////////////////////////////// - -/** - * @ngdoc function - * @name angular.element - * @module ng - * @kind function - * - * @description - * Wraps a raw DOM element or HTML string as a [jQuery](http://jquery.com) element. - * - * If jQuery is available, `angular.element` is an alias for the - * [jQuery](http://api.jquery.com/jQuery/) function. If jQuery is not available, `angular.element` - * delegates to Angular's built-in subset of jQuery, called "jQuery lite" or **jqLite**. - * - * jqLite is a tiny, API-compatible subset of jQuery that allows - * Angular to manipulate the DOM in a cross-browser compatible way. jqLite implements only the most - * commonly needed functionality with the goal of having a very small footprint. - * - * To use `jQuery`, simply ensure it is loaded before the `angular.js` file. You can also use the - * {@link ngJq `ngJq`} directive to specify that jqlite should be used over jQuery, or to use a - * specific version of jQuery if multiple versions exist on the page. - * - *
**Note:** All element references in Angular are always wrapped with jQuery or - * jqLite (such as the element argument in a directive's compile / link function). They are never raw DOM references.
- * - *
**Note:** Keep in mind that this function will not find elements - * by tag name / CSS selector. For lookups by tag name, try instead `angular.element(document).find(...)` - * or `$document.find()`, or use the standard DOM APIs, e.g. `document.querySelectorAll()`.
- * - * ## Angular's jqLite - * jqLite provides only the following jQuery methods: - * - * - [`addClass()`](http://api.jquery.com/addClass/) - Does not support a function as first argument - * - [`after()`](http://api.jquery.com/after/) - * - [`append()`](http://api.jquery.com/append/) - * - [`attr()`](http://api.jquery.com/attr/) - Does not support functions as parameters - * - [`bind()`](http://api.jquery.com/bind/) (_deprecated_, use [`on()`](http://api.jquery.com/on/)) - Does not support namespaces, selectors or eventData - * - [`children()`](http://api.jquery.com/children/) - Does not support selectors - * - [`clone()`](http://api.jquery.com/clone/) - * - [`contents()`](http://api.jquery.com/contents/) - * - [`css()`](http://api.jquery.com/css/) - Only retrieves inline-styles, does not call `getComputedStyle()`. - * As a setter, does not convert numbers to strings or append 'px', and also does not have automatic property prefixing. - * - [`data()`](http://api.jquery.com/data/) - * - [`detach()`](http://api.jquery.com/detach/) - * - [`empty()`](http://api.jquery.com/empty/) - * - [`eq()`](http://api.jquery.com/eq/) - * - [`find()`](http://api.jquery.com/find/) - Limited to lookups by tag name - * - [`hasClass()`](http://api.jquery.com/hasClass/) - * - [`html()`](http://api.jquery.com/html/) - * - [`next()`](http://api.jquery.com/next/) - Does not support selectors - * - [`on()`](http://api.jquery.com/on/) - Does not support namespaces, selectors or eventData - * - [`off()`](http://api.jquery.com/off/) - Does not support namespaces, selectors or event object as parameter - * - [`one()`](http://api.jquery.com/one/) - Does not support namespaces or selectors - * - [`parent()`](http://api.jquery.com/parent/) - Does not support selectors - * - [`prepend()`](http://api.jquery.com/prepend/) - * - [`prop()`](http://api.jquery.com/prop/) - * - [`ready()`](http://api.jquery.com/ready/) (_deprecated_, use `angular.element(callback)` instead of `angular.element(document).ready(callback)`) - * - [`remove()`](http://api.jquery.com/remove/) - * - [`removeAttr()`](http://api.jquery.com/removeAttr/) - Does not support multiple attributes - * - [`removeClass()`](http://api.jquery.com/removeClass/) - Does not support a function as first argument - * - [`removeData()`](http://api.jquery.com/removeData/) - * - [`replaceWith()`](http://api.jquery.com/replaceWith/) - * - [`text()`](http://api.jquery.com/text/) - * - [`toggleClass()`](http://api.jquery.com/toggleClass/) - Does not support a function as first argument - * - [`triggerHandler()`](http://api.jquery.com/triggerHandler/) - Passes a dummy event object to handlers - * - [`unbind()`](http://api.jquery.com/unbind/) (_deprecated_, use [`off()`](http://api.jquery.com/off/)) - Does not support namespaces or event object as parameter - * - [`val()`](http://api.jquery.com/val/) - * - [`wrap()`](http://api.jquery.com/wrap/) - * - * ## jQuery/jqLite Extras - * Angular also provides the following additional methods and events to both jQuery and jqLite: - * - * ### Events - * - `$destroy` - AngularJS intercepts all jqLite/jQuery's DOM destruction apis and fires this event - * on all DOM nodes being removed. This can be used to clean up any 3rd party bindings to the DOM - * element before it is removed. - * - * ### Methods - * - `controller(name)` - retrieves the controller of the current element or its parent. By default - * retrieves controller associated with the `ngController` directive. If `name` is provided as - * camelCase directive name, then the controller for this directive will be retrieved (e.g. - * `'ngModel'`). - * - `injector()` - retrieves the injector of the current element or its parent. - * - `scope()` - retrieves the {@link ng.$rootScope.Scope scope} of the current - * element or its parent. Requires {@link guide/production#disabling-debug-data Debug Data} to - * be enabled. - * - `isolateScope()` - retrieves an isolate {@link ng.$rootScope.Scope scope} if one is attached directly to the - * current element. This getter should be used only on elements that contain a directive which starts a new isolate - * scope. Calling `scope()` on this element always returns the original non-isolate scope. - * Requires {@link guide/production#disabling-debug-data Debug Data} to be enabled. - * - `inheritedData()` - same as `data()`, but walks up the DOM until a value is found or the top - * parent element is reached. - * - * @knownIssue You cannot spy on `angular.element` if you are using Jasmine version 1.x. See - * https://github.com/angular/angular.js/issues/14251 for more information. - * - * @param {string|DOMElement} element HTML string or DOMElement to be wrapped into jQuery. - * @returns {Object} jQuery object. - */ - -JQLite.expando = 'ng339'; - -var jqCache = JQLite.cache = {}, - jqId = 1; - -/* - * !!! This is an undocumented "private" function !!! - */ -JQLite._data = function(node) { - //jQuery always returns an object on cache miss - return this.cache[node[this.expando]] || {}; -}; - -function jqNextId() { return ++jqId; } - - -var DASH_LOWERCASE_REGEXP = /-([a-z])/g; -var MS_HACK_REGEXP = /^-ms-/; -var MOUSE_EVENT_MAP = { mouseleave: 'mouseout', mouseenter: 'mouseover' }; -var jqLiteMinErr = minErr('jqLite'); - -/** - * Converts kebab-case to camelCase. - * There is also a special case for the ms prefix starting with a lowercase letter. - * @param name Name to normalize - */ -function cssKebabToCamel(name) { - return kebabToCamel(name.replace(MS_HACK_REGEXP, 'ms-')); -} - -function fnCamelCaseReplace(all, letter) { - return letter.toUpperCase(); -} - -/** - * Converts kebab-case to camelCase. - * @param name Name to normalize - */ -function kebabToCamel(name) { - return name - .replace(DASH_LOWERCASE_REGEXP, fnCamelCaseReplace); -} - -var SINGLE_TAG_REGEXP = /^<([\w-]+)\s*\/?>(?:<\/\1>|)$/; -var HTML_REGEXP = /<|&#?\w+;/; -var TAG_NAME_REGEXP = /<([\w:-]+)/; -var XHTML_TAG_REGEXP = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:-]+)[^>]*)\/>/gi; - -var wrapMap = { - 'option': [1, ''], - - 'thead': [1, '', '
'], - 'col': [2, '', '
'], - 'tr': [2, '', '
'], - 'td': [3, '', '
'], - '_default': [0, '', ''] -}; - -wrapMap.optgroup = wrapMap.option; -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - - -function jqLiteIsTextNode(html) { - return !HTML_REGEXP.test(html); -} - -function jqLiteAcceptsData(node) { - // The window object can accept data but has no nodeType - // Otherwise we are only interested in elements (1) and documents (9) - var nodeType = node.nodeType; - return nodeType === NODE_TYPE_ELEMENT || !nodeType || nodeType === NODE_TYPE_DOCUMENT; -} - -function jqLiteHasData(node) { - for (var key in jqCache[node.ng339]) { - return true; - } - return false; -} - -function jqLiteCleanData(nodes) { - for (var i = 0, ii = nodes.length; i < ii; i++) { - jqLiteRemoveData(nodes[i]); - } -} - -function jqLiteBuildFragment(html, context) { - var tmp, tag, wrap, - fragment = context.createDocumentFragment(), - nodes = [], i; - - if (jqLiteIsTextNode(html)) { - // Convert non-html into a text node - nodes.push(context.createTextNode(html)); - } else { - // Convert html into DOM nodes - tmp = fragment.appendChild(context.createElement('div')); - tag = (TAG_NAME_REGEXP.exec(html) || ['', ''])[1].toLowerCase(); - wrap = wrapMap[tag] || wrapMap._default; - tmp.innerHTML = wrap[1] + html.replace(XHTML_TAG_REGEXP, '<$1>') + wrap[2]; - - // Descend through wrappers to the right content - i = wrap[0]; - while (i--) { - tmp = tmp.lastChild; - } - - nodes = concat(nodes, tmp.childNodes); - - tmp = fragment.firstChild; - tmp.textContent = ''; - } - - // Remove wrapper from fragment - fragment.textContent = ''; - fragment.innerHTML = ''; // Clear inner HTML - forEach(nodes, function(node) { - fragment.appendChild(node); - }); - - return fragment; -} - -function jqLiteParseHTML(html, context) { - context = context || window.document; - var parsed; - - if ((parsed = SINGLE_TAG_REGEXP.exec(html))) { - return [context.createElement(parsed[1])]; - } - - if ((parsed = jqLiteBuildFragment(html, context))) { - return parsed.childNodes; - } - - return []; -} - -function jqLiteWrapNode(node, wrapper) { - var parent = node.parentNode; - - if (parent) { - parent.replaceChild(wrapper, node); - } - - wrapper.appendChild(node); -} - - -// IE9-11 has no method "contains" in SVG element and in Node.prototype. Bug #10259. -var jqLiteContains = window.Node.prototype.contains || /** @this */ function(arg) { - // eslint-disable-next-line no-bitwise - return !!(this.compareDocumentPosition(arg) & 16); -}; - -///////////////////////////////////////////// -function JQLite(element) { - if (element instanceof JQLite) { - return element; - } - - var argIsString; - - if (isString(element)) { - element = trim(element); - argIsString = true; - } - if (!(this instanceof JQLite)) { - if (argIsString && element.charAt(0) !== '<') { - throw jqLiteMinErr('nosel', 'Looking up elements via selectors is not supported by jqLite! See: http://docs.angularjs.org/api/angular.element'); - } - return new JQLite(element); - } - - if (argIsString) { - jqLiteAddNodes(this, jqLiteParseHTML(element)); - } else if (isFunction(element)) { - jqLiteReady(element); - } else { - jqLiteAddNodes(this, element); - } -} - -function jqLiteClone(element) { - return element.cloneNode(true); -} - -function jqLiteDealoc(element, onlyDescendants) { - if (!onlyDescendants) jqLiteRemoveData(element); - - if (element.querySelectorAll) { - var descendants = element.querySelectorAll('*'); - for (var i = 0, l = descendants.length; i < l; i++) { - jqLiteRemoveData(descendants[i]); - } - } -} - -function jqLiteOff(element, type, fn, unsupported) { - if (isDefined(unsupported)) throw jqLiteMinErr('offargs', 'jqLite#off() does not support the `selector` argument'); - - var expandoStore = jqLiteExpandoStore(element); - var events = expandoStore && expandoStore.events; - var handle = expandoStore && expandoStore.handle; - - if (!handle) return; //no listeners registered - - if (!type) { - for (type in events) { - if (type !== '$destroy') { - element.removeEventListener(type, handle); - } - delete events[type]; - } - } else { - - var removeHandler = function(type) { - var listenerFns = events[type]; - if (isDefined(fn)) { - arrayRemove(listenerFns || [], fn); - } - if (!(isDefined(fn) && listenerFns && listenerFns.length > 0)) { - element.removeEventListener(type, handle); - delete events[type]; - } - }; - - forEach(type.split(' '), function(type) { - removeHandler(type); - if (MOUSE_EVENT_MAP[type]) { - removeHandler(MOUSE_EVENT_MAP[type]); - } - }); - } -} - -function jqLiteRemoveData(element, name) { - var expandoId = element.ng339; - var expandoStore = expandoId && jqCache[expandoId]; - - if (expandoStore) { - if (name) { - delete expandoStore.data[name]; - return; - } - - if (expandoStore.handle) { - if (expandoStore.events.$destroy) { - expandoStore.handle({}, '$destroy'); - } - jqLiteOff(element); - } - delete jqCache[expandoId]; - element.ng339 = undefined; // don't delete DOM expandos. IE and Chrome don't like it - } -} - - -function jqLiteExpandoStore(element, createIfNecessary) { - var expandoId = element.ng339, - expandoStore = expandoId && jqCache[expandoId]; - - if (createIfNecessary && !expandoStore) { - element.ng339 = expandoId = jqNextId(); - expandoStore = jqCache[expandoId] = {events: {}, data: {}, handle: undefined}; - } - - return expandoStore; -} - - -function jqLiteData(element, key, value) { - if (jqLiteAcceptsData(element)) { - var prop; - - var isSimpleSetter = isDefined(value); - var isSimpleGetter = !isSimpleSetter && key && !isObject(key); - var massGetter = !key; - var expandoStore = jqLiteExpandoStore(element, !isSimpleGetter); - var data = expandoStore && expandoStore.data; - - if (isSimpleSetter) { // data('key', value) - data[kebabToCamel(key)] = value; - } else { - if (massGetter) { // data() - return data; - } else { - if (isSimpleGetter) { // data('key') - // don't force creation of expandoStore if it doesn't exist yet - return data && data[kebabToCamel(key)]; - } else { // mass-setter: data({key1: val1, key2: val2}) - for (prop in key) { - data[kebabToCamel(prop)] = key[prop]; - } - } - } - } - } -} - -function jqLiteHasClass(element, selector) { - if (!element.getAttribute) return false; - return ((' ' + (element.getAttribute('class') || '') + ' ').replace(/[\n\t]/g, ' '). - indexOf(' ' + selector + ' ') > -1); -} - -function jqLiteRemoveClass(element, cssClasses) { - if (cssClasses && element.setAttribute) { - forEach(cssClasses.split(' '), function(cssClass) { - element.setAttribute('class', trim( - (' ' + (element.getAttribute('class') || '') + ' ') - .replace(/[\n\t]/g, ' ') - .replace(' ' + trim(cssClass) + ' ', ' ')) - ); - }); - } -} - -function jqLiteAddClass(element, cssClasses) { - if (cssClasses && element.setAttribute) { - var existingClasses = (' ' + (element.getAttribute('class') || '') + ' ') - .replace(/[\n\t]/g, ' '); - - forEach(cssClasses.split(' '), function(cssClass) { - cssClass = trim(cssClass); - if (existingClasses.indexOf(' ' + cssClass + ' ') === -1) { - existingClasses += cssClass + ' '; - } - }); - - element.setAttribute('class', trim(existingClasses)); - } -} - - -function jqLiteAddNodes(root, elements) { - // THIS CODE IS VERY HOT. Don't make changes without benchmarking. - - if (elements) { - - // if a Node (the most common case) - if (elements.nodeType) { - root[root.length++] = elements; - } else { - var length = elements.length; - - // if an Array or NodeList and not a Window - if (typeof length === 'number' && elements.window !== elements) { - if (length) { - for (var i = 0; i < length; i++) { - root[root.length++] = elements[i]; - } - } - } else { - root[root.length++] = elements; - } - } - } -} - - -function jqLiteController(element, name) { - return jqLiteInheritedData(element, '$' + (name || 'ngController') + 'Controller'); -} - -function jqLiteInheritedData(element, name, value) { - // if element is the document object work with the html element instead - // this makes $(document).scope() possible - if (element.nodeType === NODE_TYPE_DOCUMENT) { - element = element.documentElement; - } - var names = isArray(name) ? name : [name]; - - while (element) { - for (var i = 0, ii = names.length; i < ii; i++) { - if (isDefined(value = jqLite.data(element, names[i]))) return value; - } - - // If dealing with a document fragment node with a host element, and no parent, use the host - // element as the parent. This enables directives within a Shadow DOM or polyfilled Shadow DOM - // to lookup parent controllers. - element = element.parentNode || (element.nodeType === NODE_TYPE_DOCUMENT_FRAGMENT && element.host); - } -} - -function jqLiteEmpty(element) { - jqLiteDealoc(element, true); - while (element.firstChild) { - element.removeChild(element.firstChild); - } -} - -function jqLiteRemove(element, keepData) { - if (!keepData) jqLiteDealoc(element); - var parent = element.parentNode; - if (parent) parent.removeChild(element); -} - - -function jqLiteDocumentLoaded(action, win) { - win = win || window; - if (win.document.readyState === 'complete') { - // Force the action to be run async for consistent behavior - // from the action's point of view - // i.e. it will definitely not be in a $apply - win.setTimeout(action); - } else { - // No need to unbind this handler as load is only ever called once - jqLite(win).on('load', action); - } -} - -function jqLiteReady(fn) { - function trigger() { - window.document.removeEventListener('DOMContentLoaded', trigger); - window.removeEventListener('load', trigger); - fn(); - } - - // check if document is already loaded - if (window.document.readyState === 'complete') { - window.setTimeout(fn); - } else { - // We can not use jqLite since we are not done loading and jQuery could be loaded later. - - // Works for modern browsers and IE9 - window.document.addEventListener('DOMContentLoaded', trigger); - - // Fallback to window.onload for others - window.addEventListener('load', trigger); - } -} - -////////////////////////////////////////// -// Functions which are declared directly. -////////////////////////////////////////// -var JQLitePrototype = JQLite.prototype = { - ready: jqLiteReady, - toString: function() { - var value = []; - forEach(this, function(e) { value.push('' + e);}); - return '[' + value.join(', ') + ']'; - }, - - eq: function(index) { - return (index >= 0) ? jqLite(this[index]) : jqLite(this[this.length + index]); - }, - - length: 0, - push: push, - sort: [].sort, - splice: [].splice -}; - -////////////////////////////////////////// -// Functions iterating getter/setters. -// these functions return self on setter and -// value on get. -////////////////////////////////////////// -var BOOLEAN_ATTR = {}; -forEach('multiple,selected,checked,disabled,readOnly,required,open'.split(','), function(value) { - BOOLEAN_ATTR[lowercase(value)] = value; -}); -var BOOLEAN_ELEMENTS = {}; -forEach('input,select,option,textarea,button,form,details'.split(','), function(value) { - BOOLEAN_ELEMENTS[value] = true; -}); -var ALIASED_ATTR = { - 'ngMinlength': 'minlength', - 'ngMaxlength': 'maxlength', - 'ngMin': 'min', - 'ngMax': 'max', - 'ngPattern': 'pattern', - 'ngStep': 'step' -}; - -function getBooleanAttrName(element, name) { - // check dom last since we will most likely fail on name - var booleanAttr = BOOLEAN_ATTR[name.toLowerCase()]; - - // booleanAttr is here twice to minimize DOM access - return booleanAttr && BOOLEAN_ELEMENTS[nodeName_(element)] && booleanAttr; -} - -function getAliasedAttrName(name) { - return ALIASED_ATTR[name]; -} - -forEach({ - data: jqLiteData, - removeData: jqLiteRemoveData, - hasData: jqLiteHasData, - cleanData: jqLiteCleanData -}, function(fn, name) { - JQLite[name] = fn; -}); - -forEach({ - data: jqLiteData, - inheritedData: jqLiteInheritedData, - - scope: function(element) { - // Can't use jqLiteData here directly so we stay compatible with jQuery! - return jqLite.data(element, '$scope') || jqLiteInheritedData(element.parentNode || element, ['$isolateScope', '$scope']); - }, - - isolateScope: function(element) { - // Can't use jqLiteData here directly so we stay compatible with jQuery! - return jqLite.data(element, '$isolateScope') || jqLite.data(element, '$isolateScopeNoTemplate'); - }, - - controller: jqLiteController, - - injector: function(element) { - return jqLiteInheritedData(element, '$injector'); - }, - - removeAttr: function(element, name) { - element.removeAttribute(name); - }, - - hasClass: jqLiteHasClass, - - css: function(element, name, value) { - name = cssKebabToCamel(name); - - if (isDefined(value)) { - element.style[name] = value; - } else { - return element.style[name]; - } - }, - - attr: function(element, name, value) { - var ret; - var nodeType = element.nodeType; - if (nodeType === NODE_TYPE_TEXT || nodeType === NODE_TYPE_ATTRIBUTE || nodeType === NODE_TYPE_COMMENT || - !element.getAttribute) { - return; - } - - var lowercasedName = lowercase(name); - var isBooleanAttr = BOOLEAN_ATTR[lowercasedName]; - - if (isDefined(value)) { - // setter - - if (value === null || (value === false && isBooleanAttr)) { - element.removeAttribute(name); - } else { - element.setAttribute(name, isBooleanAttr ? lowercasedName : value); - } - } else { - // getter - - ret = element.getAttribute(name); - - if (isBooleanAttr && ret !== null) { - ret = lowercasedName; - } - // Normalize non-existing attributes to undefined (as jQuery). - return ret === null ? undefined : ret; - } - }, - - prop: function(element, name, value) { - if (isDefined(value)) { - element[name] = value; - } else { - return element[name]; - } - }, - - text: (function() { - getText.$dv = ''; - return getText; - - function getText(element, value) { - if (isUndefined(value)) { - var nodeType = element.nodeType; - return (nodeType === NODE_TYPE_ELEMENT || nodeType === NODE_TYPE_TEXT) ? element.textContent : ''; - } - element.textContent = value; - } - })(), - - val: function(element, value) { - if (isUndefined(value)) { - if (element.multiple && nodeName_(element) === 'select') { - var result = []; - forEach(element.options, function(option) { - if (option.selected) { - result.push(option.value || option.text); - } - }); - return result; - } - return element.value; - } - element.value = value; - }, - - html: function(element, value) { - if (isUndefined(value)) { - return element.innerHTML; - } - jqLiteDealoc(element, true); - element.innerHTML = value; - }, - - empty: jqLiteEmpty -}, function(fn, name) { - /** - * Properties: writes return selection, reads return first value - */ - JQLite.prototype[name] = function(arg1, arg2) { - var i, key; - var nodeCount = this.length; - - // jqLiteHasClass has only two arguments, but is a getter-only fn, so we need to special-case it - // in a way that survives minification. - // jqLiteEmpty takes no arguments but is a setter. - if (fn !== jqLiteEmpty && - (isUndefined((fn.length === 2 && (fn !== jqLiteHasClass && fn !== jqLiteController)) ? arg1 : arg2))) { - if (isObject(arg1)) { - - // we are a write, but the object properties are the key/values - for (i = 0; i < nodeCount; i++) { - if (fn === jqLiteData) { - // data() takes the whole object in jQuery - fn(this[i], arg1); - } else { - for (key in arg1) { - fn(this[i], key, arg1[key]); - } - } - } - // return self for chaining - return this; - } else { - // we are a read, so read the first child. - // TODO: do we still need this? - var value = fn.$dv; - // Only if we have $dv do we iterate over all, otherwise it is just the first element. - var jj = (isUndefined(value)) ? Math.min(nodeCount, 1) : nodeCount; - for (var j = 0; j < jj; j++) { - var nodeValue = fn(this[j], arg1, arg2); - value = value ? value + nodeValue : nodeValue; - } - return value; - } - } else { - // we are a write, so apply to all children - for (i = 0; i < nodeCount; i++) { - fn(this[i], arg1, arg2); - } - // return self for chaining - return this; - } - }; -}); - -function createEventHandler(element, events) { - var eventHandler = function(event, type) { - // jQuery specific api - event.isDefaultPrevented = function() { - return event.defaultPrevented; - }; - - var eventFns = events[type || event.type]; - var eventFnsLength = eventFns ? eventFns.length : 0; - - if (!eventFnsLength) return; - - if (isUndefined(event.immediatePropagationStopped)) { - var originalStopImmediatePropagation = event.stopImmediatePropagation; - event.stopImmediatePropagation = function() { - event.immediatePropagationStopped = true; - - if (event.stopPropagation) { - event.stopPropagation(); - } - - if (originalStopImmediatePropagation) { - originalStopImmediatePropagation.call(event); - } - }; - } - - event.isImmediatePropagationStopped = function() { - return event.immediatePropagationStopped === true; - }; - - // Some events have special handlers that wrap the real handler - var handlerWrapper = eventFns.specialHandlerWrapper || defaultHandlerWrapper; - - // Copy event handlers in case event handlers array is modified during execution. - if ((eventFnsLength > 1)) { - eventFns = shallowCopy(eventFns); - } - - for (var i = 0; i < eventFnsLength; i++) { - if (!event.isImmediatePropagationStopped()) { - handlerWrapper(element, event, eventFns[i]); - } - } - }; - - // TODO: this is a hack for angularMocks/clearDataCache that makes it possible to deregister all - // events on `element` - eventHandler.elem = element; - return eventHandler; -} - -function defaultHandlerWrapper(element, event, handler) { - handler.call(element, event); -} - -function specialMouseHandlerWrapper(target, event, handler) { - // Refer to jQuery's implementation of mouseenter & mouseleave - // Read about mouseenter and mouseleave: - // http://www.quirksmode.org/js/events_mouse.html#link8 - var related = event.relatedTarget; - // For mousenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if (!related || (related !== target && !jqLiteContains.call(target, related))) { - handler.call(target, event); - } -} - -////////////////////////////////////////// -// Functions iterating traversal. -// These functions chain results into a single -// selector. -////////////////////////////////////////// -forEach({ - removeData: jqLiteRemoveData, - - on: function jqLiteOn(element, type, fn, unsupported) { - if (isDefined(unsupported)) throw jqLiteMinErr('onargs', 'jqLite#on() does not support the `selector` or `eventData` parameters'); - - // Do not add event handlers to non-elements because they will not be cleaned up. - if (!jqLiteAcceptsData(element)) { - return; - } - - var expandoStore = jqLiteExpandoStore(element, true); - var events = expandoStore.events; - var handle = expandoStore.handle; - - if (!handle) { - handle = expandoStore.handle = createEventHandler(element, events); - } - - // http://jsperf.com/string-indexof-vs-split - var types = type.indexOf(' ') >= 0 ? type.split(' ') : [type]; - var i = types.length; - - var addHandler = function(type, specialHandlerWrapper, noEventListener) { - var eventFns = events[type]; - - if (!eventFns) { - eventFns = events[type] = []; - eventFns.specialHandlerWrapper = specialHandlerWrapper; - if (type !== '$destroy' && !noEventListener) { - element.addEventListener(type, handle); - } - } - - eventFns.push(fn); - }; - - while (i--) { - type = types[i]; - if (MOUSE_EVENT_MAP[type]) { - addHandler(MOUSE_EVENT_MAP[type], specialMouseHandlerWrapper); - addHandler(type, undefined, true); - } else { - addHandler(type); - } - } - }, - - off: jqLiteOff, - - one: function(element, type, fn) { - element = jqLite(element); - - //add the listener twice so that when it is called - //you can remove the original function and still be - //able to call element.off(ev, fn) normally - element.on(type, function onFn() { - element.off(type, fn); - element.off(type, onFn); - }); - element.on(type, fn); - }, - - replaceWith: function(element, replaceNode) { - var index, parent = element.parentNode; - jqLiteDealoc(element); - forEach(new JQLite(replaceNode), function(node) { - if (index) { - parent.insertBefore(node, index.nextSibling); - } else { - parent.replaceChild(node, element); - } - index = node; - }); - }, - - children: function(element) { - var children = []; - forEach(element.childNodes, function(element) { - if (element.nodeType === NODE_TYPE_ELEMENT) { - children.push(element); - } - }); - return children; - }, - - contents: function(element) { - return element.contentDocument || element.childNodes || []; - }, - - append: function(element, node) { - var nodeType = element.nodeType; - if (nodeType !== NODE_TYPE_ELEMENT && nodeType !== NODE_TYPE_DOCUMENT_FRAGMENT) return; - - node = new JQLite(node); - - for (var i = 0, ii = node.length; i < ii; i++) { - var child = node[i]; - element.appendChild(child); - } - }, - - prepend: function(element, node) { - if (element.nodeType === NODE_TYPE_ELEMENT) { - var index = element.firstChild; - forEach(new JQLite(node), function(child) { - element.insertBefore(child, index); - }); - } - }, - - wrap: function(element, wrapNode) { - jqLiteWrapNode(element, jqLite(wrapNode).eq(0).clone()[0]); - }, - - remove: jqLiteRemove, - - detach: function(element) { - jqLiteRemove(element, true); - }, - - after: function(element, newElement) { - var index = element, parent = element.parentNode; - newElement = new JQLite(newElement); - - for (var i = 0, ii = newElement.length; i < ii; i++) { - var node = newElement[i]; - parent.insertBefore(node, index.nextSibling); - index = node; - } - }, - - addClass: jqLiteAddClass, - removeClass: jqLiteRemoveClass, - - toggleClass: function(element, selector, condition) { - if (selector) { - forEach(selector.split(' '), function(className) { - var classCondition = condition; - if (isUndefined(classCondition)) { - classCondition = !jqLiteHasClass(element, className); - } - (classCondition ? jqLiteAddClass : jqLiteRemoveClass)(element, className); - }); - } - }, - - parent: function(element) { - var parent = element.parentNode; - return parent && parent.nodeType !== NODE_TYPE_DOCUMENT_FRAGMENT ? parent : null; - }, - - next: function(element) { - return element.nextElementSibling; - }, - - find: function(element, selector) { - if (element.getElementsByTagName) { - return element.getElementsByTagName(selector); - } else { - return []; - } - }, - - clone: jqLiteClone, - - triggerHandler: function(element, event, extraParameters) { - - var dummyEvent, eventFnsCopy, handlerArgs; - var eventName = event.type || event; - var expandoStore = jqLiteExpandoStore(element); - var events = expandoStore && expandoStore.events; - var eventFns = events && events[eventName]; - - if (eventFns) { - // Create a dummy event to pass to the handlers - dummyEvent = { - preventDefault: function() { this.defaultPrevented = true; }, - isDefaultPrevented: function() { return this.defaultPrevented === true; }, - stopImmediatePropagation: function() { this.immediatePropagationStopped = true; }, - isImmediatePropagationStopped: function() { return this.immediatePropagationStopped === true; }, - stopPropagation: noop, - type: eventName, - target: element - }; - - // If a custom event was provided then extend our dummy event with it - if (event.type) { - dummyEvent = extend(dummyEvent, event); - } - - // Copy event handlers in case event handlers array is modified during execution. - eventFnsCopy = shallowCopy(eventFns); - handlerArgs = extraParameters ? [dummyEvent].concat(extraParameters) : [dummyEvent]; - - forEach(eventFnsCopy, function(fn) { - if (!dummyEvent.isImmediatePropagationStopped()) { - fn.apply(element, handlerArgs); - } - }); - } - } -}, function(fn, name) { - /** - * chaining functions - */ - JQLite.prototype[name] = function(arg1, arg2, arg3) { - var value; - - for (var i = 0, ii = this.length; i < ii; i++) { - if (isUndefined(value)) { - value = fn(this[i], arg1, arg2, arg3); - if (isDefined(value)) { - // any function which returns a value needs to be wrapped - value = jqLite(value); - } - } else { - jqLiteAddNodes(value, fn(this[i], arg1, arg2, arg3)); - } - } - return isDefined(value) ? value : this; - }; -}); - -// bind legacy bind/unbind to on/off -JQLite.prototype.bind = JQLite.prototype.on; -JQLite.prototype.unbind = JQLite.prototype.off; - - -// Provider for private $$jqLite service -/** @this */ -function $$jqLiteProvider() { - this.$get = function $$jqLite() { - return extend(JQLite, { - hasClass: function(node, classes) { - if (node.attr) node = node[0]; - return jqLiteHasClass(node, classes); - }, - addClass: function(node, classes) { - if (node.attr) node = node[0]; - return jqLiteAddClass(node, classes); - }, - removeClass: function(node, classes) { - if (node.attr) node = node[0]; - return jqLiteRemoveClass(node, classes); - } - }); - }; -} - -/** - * Computes a hash of an 'obj'. - * Hash of a: - * string is string - * number is number as string - * object is either result of calling $$hashKey function on the object or uniquely generated id, - * that is also assigned to the $$hashKey property of the object. - * - * @param obj - * @returns {string} hash string such that the same input will have the same hash string. - * The resulting string key is in 'type:hashKey' format. - */ -function hashKey(obj, nextUidFn) { - var key = obj && obj.$$hashKey; - - if (key) { - if (typeof key === 'function') { - key = obj.$$hashKey(); - } - return key; - } - - var objType = typeof obj; - if (objType === 'function' || (objType === 'object' && obj !== null)) { - key = obj.$$hashKey = objType + ':' + (nextUidFn || nextUid)(); - } else { - key = objType + ':' + obj; - } - - return key; -} - -/** - * HashMap which can use objects as keys - */ -function HashMap(array, isolatedUid) { - if (isolatedUid) { - var uid = 0; - this.nextUid = function() { - return ++uid; - }; - } - forEach(array, this.put, this); -} -HashMap.prototype = { - /** - * Store key value pair - * @param key key to store can be any type - * @param value value to store can be any type - */ - put: function(key, value) { - this[hashKey(key, this.nextUid)] = value; - }, - - /** - * @param key - * @returns {Object} the value for the key - */ - get: function(key) { - return this[hashKey(key, this.nextUid)]; - }, - - /** - * Remove the key/value pair - * @param key - */ - remove: function(key) { - var value = this[key = hashKey(key, this.nextUid)]; - delete this[key]; - return value; - } -}; - -var $$HashMapProvider = [/** @this */function() { - this.$get = [function() { - return HashMap; - }]; -}]; - -/** - * @ngdoc function - * @module ng - * @name angular.injector - * @kind function - * - * @description - * Creates an injector object that can be used for retrieving services as well as for - * dependency injection (see {@link guide/di dependency injection}). - * - * @param {Array.} modules A list of module functions or their aliases. See - * {@link angular.module}. The `ng` module must be explicitly added. - * @param {boolean=} [strictDi=false] Whether the injector should be in strict mode, which - * disallows argument name annotation inference. - * @returns {injector} Injector object. See {@link auto.$injector $injector}. - * - * @example - * Typical usage - * ```js - * // create an injector - * var $injector = angular.injector(['ng']); - * - * // use the injector to kick off your application - * // use the type inference to auto inject arguments, or use implicit injection - * $injector.invoke(function($rootScope, $compile, $document) { - * $compile($document)($rootScope); - * $rootScope.$digest(); - * }); - * ``` - * - * Sometimes you want to get access to the injector of a currently running Angular app - * from outside Angular. Perhaps, you want to inject and compile some markup after the - * application has been bootstrapped. You can do this using the extra `injector()` added - * to JQuery/jqLite elements. See {@link angular.element}. - * - * *This is fairly rare but could be the case if a third party library is injecting the - * markup.* - * - * In the following example a new block of HTML containing a `ng-controller` - * directive is added to the end of the document body by JQuery. We then compile and link - * it into the current AngularJS scope. - * - * ```js - * var $div = $('
{{content.label}}
'); - * $(document.body).append($div); - * - * angular.element(document).injector().invoke(function($compile) { - * var scope = angular.element($div).scope(); - * $compile($div)(scope); - * }); - * ``` - */ - - -/** - * @ngdoc module - * @name auto - * @installation - * @description - * - * Implicit module which gets automatically added to each {@link auto.$injector $injector}. - */ - -var ARROW_ARG = /^([^(]+?)=>/; -var FN_ARGS = /^[^(]*\(\s*([^)]*)\)/m; -var FN_ARG_SPLIT = /,/; -var FN_ARG = /^\s*(_?)(\S+?)\1\s*$/; -var STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg; -var $injectorMinErr = minErr('$injector'); - -function stringifyFn(fn) { - // Support: Chrome 50-51 only - // Creating a new string by adding `' '` at the end, to hack around some bug in Chrome v50/51 - // (See https://github.com/angular/angular.js/issues/14487.) - // TODO (gkalpak): Remove workaround when Chrome v52 is released - return Function.prototype.toString.call(fn) + ' '; -} - -function extractArgs(fn) { - var fnText = stringifyFn(fn).replace(STRIP_COMMENTS, ''), - args = fnText.match(ARROW_ARG) || fnText.match(FN_ARGS); - return args; -} - -function anonFn(fn) { - // For anonymous functions, showing at the very least the function signature can help in - // debugging. - var args = extractArgs(fn); - if (args) { - return 'function(' + (args[1] || '').replace(/[\s\r\n]+/, ' ') + ')'; - } - return 'fn'; -} - -function annotate(fn, strictDi, name) { - var $inject, - argDecl, - last; - - if (typeof fn === 'function') { - if (!($inject = fn.$inject)) { - $inject = []; - if (fn.length) { - if (strictDi) { - if (!isString(name) || !name) { - name = fn.name || anonFn(fn); - } - throw $injectorMinErr('strictdi', - '{0} is not using explicit annotation and cannot be invoked in strict mode', name); - } - argDecl = extractArgs(fn); - forEach(argDecl[1].split(FN_ARG_SPLIT), function(arg) { - arg.replace(FN_ARG, function(all, underscore, name) { - $inject.push(name); - }); - }); - } - fn.$inject = $inject; - } - } else if (isArray(fn)) { - last = fn.length - 1; - assertArgFn(fn[last], 'fn'); - $inject = fn.slice(0, last); - } else { - assertArgFn(fn, 'fn', true); - } - return $inject; -} - -/////////////////////////////////////// - -/** - * @ngdoc service - * @name $injector - * - * @description - * - * `$injector` is used to retrieve object instances as defined by - * {@link auto.$provide provider}, instantiate types, invoke methods, - * and load modules. - * - * The following always holds true: - * - * ```js - * var $injector = angular.injector(); - * expect($injector.get('$injector')).toBe($injector); - * expect($injector.invoke(function($injector) { - * return $injector; - * })).toBe($injector); - * ``` - * - * # Injection Function Annotation - * - * JavaScript does not have annotations, and annotations are needed for dependency injection. The - * following are all valid ways of annotating function with injection arguments and are equivalent. - * - * ```js - * // inferred (only works if code not minified/obfuscated) - * $injector.invoke(function(serviceA){}); - * - * // annotated - * function explicit(serviceA) {}; - * explicit.$inject = ['serviceA']; - * $injector.invoke(explicit); - * - * // inline - * $injector.invoke(['serviceA', function(serviceA){}]); - * ``` - * - * ## Inference - * - * In JavaScript calling `toString()` on a function returns the function definition. The definition - * can then be parsed and the function arguments can be extracted. This method of discovering - * annotations is disallowed when the injector is in strict mode. - * *NOTE:* This does not work with minification, and obfuscation tools since these tools change the - * argument names. - * - * ## `$inject` Annotation - * By adding an `$inject` property onto a function the injection parameters can be specified. - * - * ## Inline - * As an array of injection names, where the last item in the array is the function to call. - */ - -/** - * @ngdoc method - * @name $injector#get - * - * @description - * Return an instance of the service. - * - * @param {string} name The name of the instance to retrieve. - * @param {string=} caller An optional string to provide the origin of the function call for error messages. - * @return {*} The instance. - */ - -/** - * @ngdoc method - * @name $injector#invoke - * - * @description - * Invoke the method and supply the method arguments from the `$injector`. - * - * @param {Function|Array.} fn The injectable function to invoke. Function parameters are - * injected according to the {@link guide/di $inject Annotation} rules. - * @param {Object=} self The `this` for the invoked method. - * @param {Object=} locals Optional object. If preset then any argument names are read from this - * object first, before the `$injector` is consulted. - * @returns {*} the value returned by the invoked `fn` function. - */ - -/** - * @ngdoc method - * @name $injector#has - * - * @description - * Allows the user to query if the particular service exists. - * - * @param {string} name Name of the service to query. - * @returns {boolean} `true` if injector has given service. - */ - -/** - * @ngdoc method - * @name $injector#instantiate - * @description - * Create a new instance of JS type. The method takes a constructor function, invokes the new - * operator, and supplies all of the arguments to the constructor function as specified by the - * constructor annotation. - * - * @param {Function} Type Annotated constructor function. - * @param {Object=} locals Optional object. If preset then any argument names are read from this - * object first, before the `$injector` is consulted. - * @returns {Object} new instance of `Type`. - */ - -/** - * @ngdoc method - * @name $injector#annotate - * - * @description - * Returns an array of service names which the function is requesting for injection. This API is - * used by the injector to determine which services need to be injected into the function when the - * function is invoked. There are three ways in which the function can be annotated with the needed - * dependencies. - * - * # Argument names - * - * The simplest form is to extract the dependencies from the arguments of the function. This is done - * by converting the function into a string using `toString()` method and extracting the argument - * names. - * ```js - * // Given - * function MyController($scope, $route) { - * // ... - * } - * - * // Then - * expect(injector.annotate(MyController)).toEqual(['$scope', '$route']); - * ``` - * - * You can disallow this method by using strict injection mode. - * - * This method does not work with code minification / obfuscation. For this reason the following - * annotation strategies are supported. - * - * # The `$inject` property - * - * If a function has an `$inject` property and its value is an array of strings, then the strings - * represent names of services to be injected into the function. - * ```js - * // Given - * var MyController = function(obfuscatedScope, obfuscatedRoute) { - * // ... - * } - * // Define function dependencies - * MyController['$inject'] = ['$scope', '$route']; - * - * // Then - * expect(injector.annotate(MyController)).toEqual(['$scope', '$route']); - * ``` - * - * # The array notation - * - * It is often desirable to inline Injected functions and that's when setting the `$inject` property - * is very inconvenient. In these situations using the array notation to specify the dependencies in - * a way that survives minification is a better choice: - * - * ```js - * // We wish to write this (not minification / obfuscation safe) - * injector.invoke(function($compile, $rootScope) { - * // ... - * }); - * - * // We are forced to write break inlining - * var tmpFn = function(obfuscatedCompile, obfuscatedRootScope) { - * // ... - * }; - * tmpFn.$inject = ['$compile', '$rootScope']; - * injector.invoke(tmpFn); - * - * // To better support inline function the inline annotation is supported - * injector.invoke(['$compile', '$rootScope', function(obfCompile, obfRootScope) { - * // ... - * }]); - * - * // Therefore - * expect(injector.annotate( - * ['$compile', '$rootScope', function(obfus_$compile, obfus_$rootScope) {}]) - * ).toEqual(['$compile', '$rootScope']); - * ``` - * - * @param {Function|Array.} fn Function for which dependent service names need to - * be retrieved as described above. - * - * @param {boolean=} [strictDi=false] Disallow argument name annotation inference. - * - * @returns {Array.} The names of the services which the function requires. - */ - - - -/** - * @ngdoc service - * @name $provide - * - * @description - * - * The {@link auto.$provide $provide} service has a number of methods for registering components - * with the {@link auto.$injector $injector}. Many of these functions are also exposed on - * {@link angular.Module}. - * - * An Angular **service** is a singleton object created by a **service factory**. These **service - * factories** are functions which, in turn, are created by a **service provider**. - * The **service providers** are constructor functions. When instantiated they must contain a - * property called `$get`, which holds the **service factory** function. - * - * When you request a service, the {@link auto.$injector $injector} is responsible for finding the - * correct **service provider**, instantiating it and then calling its `$get` **service factory** - * function to get the instance of the **service**. - * - * Often services have no configuration options and there is no need to add methods to the service - * provider. The provider will be no more than a constructor function with a `$get` property. For - * these cases the {@link auto.$provide $provide} service has additional helper methods to register - * services without specifying a provider. - * - * * {@link auto.$provide#provider provider(name, provider)} - registers a **service provider** with the - * {@link auto.$injector $injector} - * * {@link auto.$provide#constant constant(name, obj)} - registers a value/object that can be accessed by - * providers and services. - * * {@link auto.$provide#value value(name, obj)} - registers a value/object that can only be accessed by - * services, not providers. - * * {@link auto.$provide#factory factory(name, fn)} - registers a service **factory function** - * that will be wrapped in a **service provider** object, whose `$get` property will contain the - * given factory function. - * * {@link auto.$provide#service service(name, Fn)} - registers a **constructor function** - * that will be wrapped in a **service provider** object, whose `$get` property will instantiate - * a new object using the given constructor function. - * * {@link auto.$provide#decorator decorator(name, decorFn)} - registers a **decorator function** that - * will be able to modify or replace the implementation of another service. - * - * See the individual methods for more information and examples. - */ - -/** - * @ngdoc method - * @name $provide#provider - * @description - * - * Register a **provider function** with the {@link auto.$injector $injector}. Provider functions - * are constructor functions, whose instances are responsible for "providing" a factory for a - * service. - * - * Service provider names start with the name of the service they provide followed by `Provider`. - * For example, the {@link ng.$log $log} service has a provider called - * {@link ng.$logProvider $logProvider}. - * - * Service provider objects can have additional methods which allow configuration of the provider - * and its service. Importantly, you can configure what kind of service is created by the `$get` - * method, or how that service will act. For example, the {@link ng.$logProvider $logProvider} has a - * method {@link ng.$logProvider#debugEnabled debugEnabled} - * which lets you specify whether the {@link ng.$log $log} service will log debug messages to the - * console or not. - * - * @param {string} name The name of the instance. NOTE: the provider will be available under `name + - 'Provider'` key. - * @param {(Object|function())} provider If the provider is: - * - * - `Object`: then it should have a `$get` method. The `$get` method will be invoked using - * {@link auto.$injector#invoke $injector.invoke()} when an instance needs to be created. - * - `Constructor`: a new instance of the provider will be created using - * {@link auto.$injector#instantiate $injector.instantiate()}, then treated as `object`. - * - * @returns {Object} registered provider instance - - * @example - * - * The following example shows how to create a simple event tracking service and register it using - * {@link auto.$provide#provider $provide.provider()}. - * - * ```js - * // Define the eventTracker provider - * function EventTrackerProvider() { - * var trackingUrl = '/track'; - * - * // A provider method for configuring where the tracked events should been saved - * this.setTrackingUrl = function(url) { - * trackingUrl = url; - * }; - * - * // The service factory function - * this.$get = ['$http', function($http) { - * var trackedEvents = {}; - * return { - * // Call this to track an event - * event: function(event) { - * var count = trackedEvents[event] || 0; - * count += 1; - * trackedEvents[event] = count; - * return count; - * }, - * // Call this to save the tracked events to the trackingUrl - * save: function() { - * $http.post(trackingUrl, trackedEvents); - * } - * }; - * }]; - * } - * - * describe('eventTracker', function() { - * var postSpy; - * - * beforeEach(module(function($provide) { - * // Register the eventTracker provider - * $provide.provider('eventTracker', EventTrackerProvider); - * })); - * - * beforeEach(module(function(eventTrackerProvider) { - * // Configure eventTracker provider - * eventTrackerProvider.setTrackingUrl('/custom-track'); - * })); - * - * it('tracks events', inject(function(eventTracker) { - * expect(eventTracker.event('login')).toEqual(1); - * expect(eventTracker.event('login')).toEqual(2); - * })); - * - * it('saves to the tracking url', inject(function(eventTracker, $http) { - * postSpy = spyOn($http, 'post'); - * eventTracker.event('login'); - * eventTracker.save(); - * expect(postSpy).toHaveBeenCalled(); - * expect(postSpy.mostRecentCall.args[0]).not.toEqual('/track'); - * expect(postSpy.mostRecentCall.args[0]).toEqual('/custom-track'); - * expect(postSpy.mostRecentCall.args[1]).toEqual({ 'login': 1 }); - * })); - * }); - * ``` - */ - -/** - * @ngdoc method - * @name $provide#factory - * @description - * - * Register a **service factory**, which will be called to return the service instance. - * This is short for registering a service where its provider consists of only a `$get` property, - * which is the given service factory function. - * You should use {@link auto.$provide#factory $provide.factory(getFn)} if you do not need to - * configure your service in a provider. - * - * @param {string} name The name of the instance. - * @param {Function|Array.} $getFn The injectable $getFn for the instance creation. - * Internally this is a short hand for `$provide.provider(name, {$get: $getFn})`. - * @returns {Object} registered provider instance - * - * @example - * Here is an example of registering a service - * ```js - * $provide.factory('ping', ['$http', function($http) { - * return function ping() { - * return $http.send('/ping'); - * }; - * }]); - * ``` - * You would then inject and use this service like this: - * ```js - * someModule.controller('Ctrl', ['ping', function(ping) { - * ping(); - * }]); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#service - * @description - * - * Register a **service constructor**, which will be invoked with `new` to create the service - * instance. - * This is short for registering a service where its provider's `$get` property is a factory - * function that returns an instance instantiated by the injector from the service constructor - * function. - * - * Internally it looks a bit like this: - * - * ``` - * { - * $get: function() { - * return $injector.instantiate(constructor); - * } - * } - * ``` - * - * - * You should use {@link auto.$provide#service $provide.service(class)} if you define your service - * as a type/class. - * - * @param {string} name The name of the instance. - * @param {Function|Array.} constructor An injectable class (constructor function) - * that will be instantiated. - * @returns {Object} registered provider instance - * - * @example - * Here is an example of registering a service using - * {@link auto.$provide#service $provide.service(class)}. - * ```js - * var Ping = function($http) { - * this.$http = $http; - * }; - * - * Ping.$inject = ['$http']; - * - * Ping.prototype.send = function() { - * return this.$http.get('/ping'); - * }; - * $provide.service('ping', Ping); - * ``` - * You would then inject and use this service like this: - * ```js - * someModule.controller('Ctrl', ['ping', function(ping) { - * ping.send(); - * }]); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#value - * @description - * - * Register a **value service** with the {@link auto.$injector $injector}, such as a string, a - * number, an array, an object or a function. This is short for registering a service where its - * provider's `$get` property is a factory function that takes no arguments and returns the **value - * service**. That also means it is not possible to inject other services into a value service. - * - * Value services are similar to constant services, except that they cannot be injected into a - * module configuration function (see {@link angular.Module#config}) but they can be overridden by - * an Angular {@link auto.$provide#decorator decorator}. - * - * @param {string} name The name of the instance. - * @param {*} value The value. - * @returns {Object} registered provider instance - * - * @example - * Here are some examples of creating value services. - * ```js - * $provide.value('ADMIN_USER', 'admin'); - * - * $provide.value('RoleLookup', { admin: 0, writer: 1, reader: 2 }); - * - * $provide.value('halfOf', function(value) { - * return value / 2; - * }); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#constant - * @description - * - * Register a **constant service** with the {@link auto.$injector $injector}, such as a string, - * a number, an array, an object or a function. Like the {@link auto.$provide#value value}, it is not - * possible to inject other services into a constant. - * - * But unlike {@link auto.$provide#value value}, a constant can be - * injected into a module configuration function (see {@link angular.Module#config}) and it cannot - * be overridden by an Angular {@link auto.$provide#decorator decorator}. - * - * @param {string} name The name of the constant. - * @param {*} value The constant value. - * @returns {Object} registered instance - * - * @example - * Here a some examples of creating constants: - * ```js - * $provide.constant('SHARD_HEIGHT', 306); - * - * $provide.constant('MY_COLOURS', ['red', 'blue', 'grey']); - * - * $provide.constant('double', function(value) { - * return value * 2; - * }); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#decorator - * @description - * - * Register a **decorator function** with the {@link auto.$injector $injector}. A decorator function - * intercepts the creation of a service, allowing it to override or modify the behavior of the - * service. The return value of the decorator function may be the original service, or a new service - * that replaces (or wraps and delegates to) the original service. - * - * You can find out more about using decorators in the {@link guide/decorators} guide. - * - * @param {string} name The name of the service to decorate. - * @param {Function|Array.} decorator This function will be invoked when the service needs to be - * provided and should return the decorated service instance. The function is called using - * the {@link auto.$injector#invoke injector.invoke} method and is therefore fully injectable. - * Local injection arguments: - * - * * `$delegate` - The original service instance, which can be replaced, monkey patched, configured, - * decorated or delegated to. - * - * @example - * Here we decorate the {@link ng.$log $log} service to convert warnings to errors by intercepting - * calls to {@link ng.$log#error $log.warn()}. - * ```js - * $provide.decorator('$log', ['$delegate', function($delegate) { - * $delegate.warn = $delegate.error; - * return $delegate; - * }]); - * ``` - */ - - -function createInjector(modulesToLoad, strictDi) { - strictDi = (strictDi === true); - var INSTANTIATING = {}, - providerSuffix = 'Provider', - path = [], - loadedModules = new HashMap([], true), - providerCache = { - $provide: { - provider: supportObject(provider), - factory: supportObject(factory), - service: supportObject(service), - value: supportObject(value), - constant: supportObject(constant), - decorator: decorator - } - }, - providerInjector = (providerCache.$injector = - createInternalInjector(providerCache, function(serviceName, caller) { - if (angular.isString(caller)) { - path.push(caller); - } - throw $injectorMinErr('unpr', 'Unknown provider: {0}', path.join(' <- ')); - })), - instanceCache = {}, - protoInstanceInjector = - createInternalInjector(instanceCache, function(serviceName, caller) { - var provider = providerInjector.get(serviceName + providerSuffix, caller); - return instanceInjector.invoke( - provider.$get, provider, undefined, serviceName); - }), - instanceInjector = protoInstanceInjector; - - providerCache['$injector' + providerSuffix] = { $get: valueFn(protoInstanceInjector) }; - var runBlocks = loadModules(modulesToLoad); - instanceInjector = protoInstanceInjector.get('$injector'); - instanceInjector.strictDi = strictDi; - forEach(runBlocks, function(fn) { if (fn) instanceInjector.invoke(fn); }); - - return instanceInjector; - - //////////////////////////////////// - // $provider - //////////////////////////////////// - - function supportObject(delegate) { - return function(key, value) { - if (isObject(key)) { - forEach(key, reverseParams(delegate)); - } else { - return delegate(key, value); - } - }; - } - - function provider(name, provider_) { - assertNotHasOwnProperty(name, 'service'); - if (isFunction(provider_) || isArray(provider_)) { - provider_ = providerInjector.instantiate(provider_); - } - if (!provider_.$get) { - throw $injectorMinErr('pget', 'Provider \'{0}\' must define $get factory method.', name); - } - return (providerCache[name + providerSuffix] = provider_); - } - - function enforceReturnValue(name, factory) { - return /** @this */ function enforcedReturnValue() { - var result = instanceInjector.invoke(factory, this); - if (isUndefined(result)) { - throw $injectorMinErr('undef', 'Provider \'{0}\' must return a value from $get factory method.', name); - } - return result; - }; - } - - function factory(name, factoryFn, enforce) { - return provider(name, { - $get: enforce !== false ? enforceReturnValue(name, factoryFn) : factoryFn - }); - } - - function service(name, constructor) { - return factory(name, ['$injector', function($injector) { - return $injector.instantiate(constructor); - }]); - } - - function value(name, val) { return factory(name, valueFn(val), false); } - - function constant(name, value) { - assertNotHasOwnProperty(name, 'constant'); - providerCache[name] = value; - instanceCache[name] = value; - } - - function decorator(serviceName, decorFn) { - var origProvider = providerInjector.get(serviceName + providerSuffix), - orig$get = origProvider.$get; - - origProvider.$get = function() { - var origInstance = instanceInjector.invoke(orig$get, origProvider); - return instanceInjector.invoke(decorFn, null, {$delegate: origInstance}); - }; - } - - //////////////////////////////////// - // Module Loading - //////////////////////////////////// - function loadModules(modulesToLoad) { - assertArg(isUndefined(modulesToLoad) || isArray(modulesToLoad), 'modulesToLoad', 'not an array'); - var runBlocks = [], moduleFn; - forEach(modulesToLoad, function(module) { - if (loadedModules.get(module)) return; - loadedModules.put(module, true); - - function runInvokeQueue(queue) { - var i, ii; - for (i = 0, ii = queue.length; i < ii; i++) { - var invokeArgs = queue[i], - provider = providerInjector.get(invokeArgs[0]); - - provider[invokeArgs[1]].apply(provider, invokeArgs[2]); - } - } - - try { - if (isString(module)) { - moduleFn = angularModule(module); - runBlocks = runBlocks.concat(loadModules(moduleFn.requires)).concat(moduleFn._runBlocks); - runInvokeQueue(moduleFn._invokeQueue); - runInvokeQueue(moduleFn._configBlocks); - } else if (isFunction(module)) { - runBlocks.push(providerInjector.invoke(module)); - } else if (isArray(module)) { - runBlocks.push(providerInjector.invoke(module)); - } else { - assertArgFn(module, 'module'); - } - } catch (e) { - if (isArray(module)) { - module = module[module.length - 1]; - } - if (e.message && e.stack && e.stack.indexOf(e.message) === -1) { - // Safari & FF's stack traces don't contain error.message content - // unlike those of Chrome and IE - // So if stack doesn't contain message, we create a new string that contains both. - // Since error.stack is read-only in Safari, I'm overriding e and not e.stack here. - // eslint-disable-next-line no-ex-assign - e = e.message + '\n' + e.stack; - } - throw $injectorMinErr('modulerr', 'Failed to instantiate module {0} due to:\n{1}', - module, e.stack || e.message || e); - } - }); - return runBlocks; - } - - //////////////////////////////////// - // internal Injector - //////////////////////////////////// - - function createInternalInjector(cache, factory) { - - function getService(serviceName, caller) { - if (cache.hasOwnProperty(serviceName)) { - if (cache[serviceName] === INSTANTIATING) { - throw $injectorMinErr('cdep', 'Circular dependency found: {0}', - serviceName + ' <- ' + path.join(' <- ')); - } - return cache[serviceName]; - } else { - try { - path.unshift(serviceName); - cache[serviceName] = INSTANTIATING; - cache[serviceName] = factory(serviceName, caller); - return cache[serviceName]; - } catch (err) { - if (cache[serviceName] === INSTANTIATING) { - delete cache[serviceName]; - } - throw err; - } finally { - path.shift(); - } - } - } - - - function injectionArgs(fn, locals, serviceName) { - var args = [], - $inject = createInjector.$$annotate(fn, strictDi, serviceName); - - for (var i = 0, length = $inject.length; i < length; i++) { - var key = $inject[i]; - if (typeof key !== 'string') { - throw $injectorMinErr('itkn', - 'Incorrect injection token! Expected service name as string, got {0}', key); - } - args.push(locals && locals.hasOwnProperty(key) ? locals[key] : - getService(key, serviceName)); - } - return args; - } - - function isClass(func) { - // Support: IE 9-11 only - // IE 9-11 do not support classes and IE9 leaks with the code below. - if (msie || typeof func !== 'function') { - return false; - } - var result = func.$$ngIsClass; - if (!isBoolean(result)) { - // Support: Edge 12-13 only - // See: https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/6156135/ - result = func.$$ngIsClass = /^(?:class\b|constructor\()/.test(stringifyFn(func)); - } - return result; - } - - function invoke(fn, self, locals, serviceName) { - if (typeof locals === 'string') { - serviceName = locals; - locals = null; - } - - var args = injectionArgs(fn, locals, serviceName); - if (isArray(fn)) { - fn = fn[fn.length - 1]; - } - - if (!isClass(fn)) { - // http://jsperf.com/angularjs-invoke-apply-vs-switch - // #5388 - return fn.apply(self, args); - } else { - args.unshift(null); - return new (Function.prototype.bind.apply(fn, args))(); - } - } - - - function instantiate(Type, locals, serviceName) { - // Check if Type is annotated and use just the given function at n-1 as parameter - // e.g. someModule.factory('greeter', ['$window', function(renamed$window) {}]); - var ctor = (isArray(Type) ? Type[Type.length - 1] : Type); - var args = injectionArgs(Type, locals, serviceName); - // Empty object at position 0 is ignored for invocation with `new`, but required. - args.unshift(null); - return new (Function.prototype.bind.apply(ctor, args))(); - } - - - return { - invoke: invoke, - instantiate: instantiate, - get: getService, - annotate: createInjector.$$annotate, - has: function(name) { - return providerCache.hasOwnProperty(name + providerSuffix) || cache.hasOwnProperty(name); - } - }; - } -} - -createInjector.$$annotate = annotate; - -/** - * @ngdoc provider - * @name $anchorScrollProvider - * @this - * - * @description - * Use `$anchorScrollProvider` to disable automatic scrolling whenever - * {@link ng.$location#hash $location.hash()} changes. - */ -function $AnchorScrollProvider() { - - var autoScrollingEnabled = true; - - /** - * @ngdoc method - * @name $anchorScrollProvider#disableAutoScrolling - * - * @description - * By default, {@link ng.$anchorScroll $anchorScroll()} will automatically detect changes to - * {@link ng.$location#hash $location.hash()} and scroll to the element matching the new hash.
- * Use this method to disable automatic scrolling. - * - * If automatic scrolling is disabled, one must explicitly call - * {@link ng.$anchorScroll $anchorScroll()} in order to scroll to the element related to the - * current hash. - */ - this.disableAutoScrolling = function() { - autoScrollingEnabled = false; - }; - - /** - * @ngdoc service - * @name $anchorScroll - * @kind function - * @requires $window - * @requires $location - * @requires $rootScope - * - * @description - * When called, it scrolls to the element related to the specified `hash` or (if omitted) to the - * current value of {@link ng.$location#hash $location.hash()}, according to the rules specified - * in the - * [HTML5 spec](http://www.w3.org/html/wg/drafts/html/master/browsers.html#an-indicated-part-of-the-document). - * - * It also watches the {@link ng.$location#hash $location.hash()} and automatically scrolls to - * match any anchor whenever it changes. This can be disabled by calling - * {@link ng.$anchorScrollProvider#disableAutoScrolling $anchorScrollProvider.disableAutoScrolling()}. - * - * Additionally, you can use its {@link ng.$anchorScroll#yOffset yOffset} property to specify a - * vertical scroll-offset (either fixed or dynamic). - * - * @param {string=} hash The hash specifying the element to scroll to. If omitted, the value of - * {@link ng.$location#hash $location.hash()} will be used. - * - * @property {(number|function|jqLite)} yOffset - * If set, specifies a vertical scroll-offset. This is often useful when there are fixed - * positioned elements at the top of the page, such as navbars, headers etc. - * - * `yOffset` can be specified in various ways: - * - **number**: A fixed number of pixels to be used as offset.

- * - **function**: A getter function called everytime `$anchorScroll()` is executed. Must return - * a number representing the offset (in pixels).

- * - **jqLite**: A jqLite/jQuery element to be used for specifying the offset. The distance from - * the top of the page to the element's bottom will be used as offset.
- * **Note**: The element will be taken into account only as long as its `position` is set to - * `fixed`. This option is useful, when dealing with responsive navbars/headers that adjust - * their height and/or positioning according to the viewport's size. - * - *
- *
- * In order for `yOffset` to work properly, scrolling should take place on the document's root and - * not some child element. - *
- * - * @example - - -
- Go to bottom - You're at the bottom! -
- - - angular.module('anchorScrollExample', []) - .controller('ScrollController', ['$scope', '$location', '$anchorScroll', - function($scope, $location, $anchorScroll) { - $scope.gotoBottom = function() { - // set the location.hash to the id of - // the element you wish to scroll to. - $location.hash('bottom'); - - // call $anchorScroll() - $anchorScroll(); - }; - }]); - - - #scrollArea { - height: 280px; - overflow: auto; - } - - #bottom { - display: block; - margin-top: 2000px; - } - - - * - *
- * The example below illustrates the use of a vertical scroll-offset (specified as a fixed value). - * See {@link ng.$anchorScroll#yOffset $anchorScroll.yOffset} for more details. - * - * @example - - -
- - Go to anchor {{x}} - -
-
- Anchor {{x}} of 5 -
- - - angular.module('anchorScrollOffsetExample', []) - .run(['$anchorScroll', function($anchorScroll) { - $anchorScroll.yOffset = 50; // always scroll by 50 extra pixels - }]) - .controller('headerCtrl', ['$anchorScroll', '$location', '$scope', - function($anchorScroll, $location, $scope) { - $scope.gotoAnchor = function(x) { - var newHash = 'anchor' + x; - if ($location.hash() !== newHash) { - // set the $location.hash to `newHash` and - // $anchorScroll will automatically scroll to it - $location.hash('anchor' + x); - } else { - // call $anchorScroll() explicitly, - // since $location.hash hasn't changed - $anchorScroll(); - } - }; - } - ]); - - - body { - padding-top: 50px; - } - - .anchor { - border: 2px dashed DarkOrchid; - padding: 10px 10px 200px 10px; - } - - .fixed-header { - background-color: rgba(0, 0, 0, 0.2); - height: 50px; - position: fixed; - top: 0; left: 0; right: 0; - } - - .fixed-header > a { - display: inline-block; - margin: 5px 15px; - } - - - */ - this.$get = ['$window', '$location', '$rootScope', function($window, $location, $rootScope) { - var document = $window.document; - - // Helper function to get first anchor from a NodeList - // (using `Array#some()` instead of `angular#forEach()` since it's more performant - // and working in all supported browsers.) - function getFirstAnchor(list) { - var result = null; - Array.prototype.some.call(list, function(element) { - if (nodeName_(element) === 'a') { - result = element; - return true; - } - }); - return result; - } - - function getYOffset() { - - var offset = scroll.yOffset; - - if (isFunction(offset)) { - offset = offset(); - } else if (isElement(offset)) { - var elem = offset[0]; - var style = $window.getComputedStyle(elem); - if (style.position !== 'fixed') { - offset = 0; - } else { - offset = elem.getBoundingClientRect().bottom; - } - } else if (!isNumber(offset)) { - offset = 0; - } - - return offset; - } - - function scrollTo(elem) { - if (elem) { - elem.scrollIntoView(); - - var offset = getYOffset(); - - if (offset) { - // `offset` is the number of pixels we should scroll UP in order to align `elem` properly. - // This is true ONLY if the call to `elem.scrollIntoView()` initially aligns `elem` at the - // top of the viewport. - // - // IF the number of pixels from the top of `elem` to the end of the page's content is less - // than the height of the viewport, then `elem.scrollIntoView()` will align the `elem` some - // way down the page. - // - // This is often the case for elements near the bottom of the page. - // - // In such cases we do not need to scroll the whole `offset` up, just the difference between - // the top of the element and the offset, which is enough to align the top of `elem` at the - // desired position. - var elemTop = elem.getBoundingClientRect().top; - $window.scrollBy(0, elemTop - offset); - } - } else { - $window.scrollTo(0, 0); - } - } - - function scroll(hash) { - // Allow numeric hashes - hash = isString(hash) ? hash : isNumber(hash) ? hash.toString() : $location.hash(); - var elm; - - // empty hash, scroll to the top of the page - if (!hash) scrollTo(null); - - // element with given id - else if ((elm = document.getElementById(hash))) scrollTo(elm); - - // first anchor with given name :-D - else if ((elm = getFirstAnchor(document.getElementsByName(hash)))) scrollTo(elm); - - // no element and hash === 'top', scroll to the top of the page - else if (hash === 'top') scrollTo(null); - } - - // does not scroll when user clicks on anchor link that is currently on - // (no url change, no $location.hash() change), browser native does scroll - if (autoScrollingEnabled) { - $rootScope.$watch(function autoScrollWatch() {return $location.hash();}, - function autoScrollWatchAction(newVal, oldVal) { - // skip the initial scroll if $location.hash is empty - if (newVal === oldVal && newVal === '') return; - - jqLiteDocumentLoaded(function() { - $rootScope.$evalAsync(scroll); - }); - }); - } - - return scroll; - }]; -} - -var $animateMinErr = minErr('$animate'); -var ELEMENT_NODE = 1; -var NG_ANIMATE_CLASSNAME = 'ng-animate'; - -function mergeClasses(a,b) { - if (!a && !b) return ''; - if (!a) return b; - if (!b) return a; - if (isArray(a)) a = a.join(' '); - if (isArray(b)) b = b.join(' '); - return a + ' ' + b; -} - -function extractElementNode(element) { - for (var i = 0; i < element.length; i++) { - var elm = element[i]; - if (elm.nodeType === ELEMENT_NODE) { - return elm; - } - } -} - -function splitClasses(classes) { - if (isString(classes)) { - classes = classes.split(' '); - } - - // Use createMap() to prevent class assumptions involving property names in - // Object.prototype - var obj = createMap(); - forEach(classes, function(klass) { - // sometimes the split leaves empty string values - // incase extra spaces were applied to the options - if (klass.length) { - obj[klass] = true; - } - }); - return obj; -} - -// if any other type of options value besides an Object value is -// passed into the $animate.method() animation then this helper code -// will be run which will ignore it. While this patch is not the -// greatest solution to this, a lot of existing plugins depend on -// $animate to either call the callback (< 1.2) or return a promise -// that can be changed. This helper function ensures that the options -// are wiped clean incase a callback function is provided. -function prepareAnimateOptions(options) { - return isObject(options) - ? options - : {}; -} - -var $$CoreAnimateJsProvider = /** @this */ function() { - this.$get = noop; -}; - -// this is prefixed with Core since it conflicts with -// the animateQueueProvider defined in ngAnimate/animateQueue.js -var $$CoreAnimateQueueProvider = /** @this */ function() { - var postDigestQueue = new HashMap(); - var postDigestElements = []; - - this.$get = ['$$AnimateRunner', '$rootScope', - function($$AnimateRunner, $rootScope) { - return { - enabled: noop, - on: noop, - off: noop, - pin: noop, - - push: function(element, event, options, domOperation) { - if (domOperation) { - domOperation(); - } - - options = options || {}; - if (options.from) { - element.css(options.from); - } - if (options.to) { - element.css(options.to); - } - - if (options.addClass || options.removeClass) { - addRemoveClassesPostDigest(element, options.addClass, options.removeClass); - } - - var runner = new $$AnimateRunner(); - - // since there are no animations to run the runner needs to be - // notified that the animation call is complete. - runner.complete(); - return runner; - } - }; - - - function updateData(data, classes, value) { - var changed = false; - if (classes) { - classes = isString(classes) ? classes.split(' ') : - isArray(classes) ? classes : []; - forEach(classes, function(className) { - if (className) { - changed = true; - data[className] = value; - } - }); - } - return changed; - } - - function handleCSSClassChanges() { - forEach(postDigestElements, function(element) { - var data = postDigestQueue.get(element); - if (data) { - var existing = splitClasses(element.attr('class')); - var toAdd = ''; - var toRemove = ''; - forEach(data, function(status, className) { - var hasClass = !!existing[className]; - if (status !== hasClass) { - if (status) { - toAdd += (toAdd.length ? ' ' : '') + className; - } else { - toRemove += (toRemove.length ? ' ' : '') + className; - } - } - }); - - forEach(element, function(elm) { - if (toAdd) { - jqLiteAddClass(elm, toAdd); - } - if (toRemove) { - jqLiteRemoveClass(elm, toRemove); - } - }); - postDigestQueue.remove(element); - } - }); - postDigestElements.length = 0; - } - - - function addRemoveClassesPostDigest(element, add, remove) { - var data = postDigestQueue.get(element) || {}; - - var classesAdded = updateData(data, add, true); - var classesRemoved = updateData(data, remove, false); - - if (classesAdded || classesRemoved) { - - postDigestQueue.put(element, data); - postDigestElements.push(element); - - if (postDigestElements.length === 1) { - $rootScope.$$postDigest(handleCSSClassChanges); - } - } - } - }]; -}; - -/** - * @ngdoc provider - * @name $animateProvider - * - * @description - * Default implementation of $animate that doesn't perform any animations, instead just - * synchronously performs DOM updates and resolves the returned runner promise. - * - * In order to enable animations the `ngAnimate` module has to be loaded. - * - * To see the functional implementation check out `src/ngAnimate/animate.js`. - */ -var $AnimateProvider = ['$provide', /** @this */ function($provide) { - var provider = this; - - this.$$registeredAnimations = Object.create(null); - - /** - * @ngdoc method - * @name $animateProvider#register - * - * @description - * Registers a new injectable animation factory function. The factory function produces the - * animation object which contains callback functions for each event that is expected to be - * animated. - * - * * `eventFn`: `function(element, ... , doneFunction, options)` - * The element to animate, the `doneFunction` and the options fed into the animation. Depending - * on the type of animation additional arguments will be injected into the animation function. The - * list below explains the function signatures for the different animation methods: - * - * - setClass: function(element, addedClasses, removedClasses, doneFunction, options) - * - addClass: function(element, addedClasses, doneFunction, options) - * - removeClass: function(element, removedClasses, doneFunction, options) - * - enter, leave, move: function(element, doneFunction, options) - * - animate: function(element, fromStyles, toStyles, doneFunction, options) - * - * Make sure to trigger the `doneFunction` once the animation is fully complete. - * - * ```js - * return { - * //enter, leave, move signature - * eventFn : function(element, done, options) { - * //code to run the animation - * //once complete, then run done() - * return function endFunction(wasCancelled) { - * //code to cancel the animation - * } - * } - * } - * ``` - * - * @param {string} name The name of the animation (this is what the class-based CSS value will be compared to). - * @param {Function} factory The factory function that will be executed to return the animation - * object. - */ - this.register = function(name, factory) { - if (name && name.charAt(0) !== '.') { - throw $animateMinErr('notcsel', 'Expecting class selector starting with \'.\' got \'{0}\'.', name); - } - - var key = name + '-animation'; - provider.$$registeredAnimations[name.substr(1)] = key; - $provide.factory(key, factory); - }; - - /** - * @ngdoc method - * @name $animateProvider#classNameFilter - * - * @description - * Sets and/or returns the CSS class regular expression that is checked when performing - * an animation. Upon bootstrap the classNameFilter value is not set at all and will - * therefore enable $animate to attempt to perform an animation on any element that is triggered. - * When setting the `classNameFilter` value, animations will only be performed on elements - * that successfully match the filter expression. This in turn can boost performance - * for low-powered devices as well as applications containing a lot of structural operations. - * @param {RegExp=} expression The className expression which will be checked against all animations - * @return {RegExp} The current CSS className expression value. If null then there is no expression value - */ - this.classNameFilter = function(expression) { - if (arguments.length === 1) { - this.$$classNameFilter = (expression instanceof RegExp) ? expression : null; - if (this.$$classNameFilter) { - var reservedRegex = new RegExp('(\\s+|\\/)' + NG_ANIMATE_CLASSNAME + '(\\s+|\\/)'); - if (reservedRegex.test(this.$$classNameFilter.toString())) { - throw $animateMinErr('nongcls','$animateProvider.classNameFilter(regex) prohibits accepting a regex value which matches/contains the "{0}" CSS class.', NG_ANIMATE_CLASSNAME); - } - } - } - return this.$$classNameFilter; - }; - - this.$get = ['$$animateQueue', function($$animateQueue) { - function domInsert(element, parentElement, afterElement) { - // if for some reason the previous element was removed - // from the dom sometime before this code runs then let's - // just stick to using the parent element as the anchor - if (afterElement) { - var afterNode = extractElementNode(afterElement); - if (afterNode && !afterNode.parentNode && !afterNode.previousElementSibling) { - afterElement = null; - } - } - if (afterElement) { - afterElement.after(element); - } else { - parentElement.prepend(element); - } - } - - /** - * @ngdoc service - * @name $animate - * @description The $animate service exposes a series of DOM utility methods that provide support - * for animation hooks. The default behavior is the application of DOM operations, however, - * when an animation is detected (and animations are enabled), $animate will do the heavy lifting - * to ensure that animation runs with the triggered DOM operation. - * - * By default $animate doesn't trigger any animations. This is because the `ngAnimate` module isn't - * included and only when it is active then the animation hooks that `$animate` triggers will be - * functional. Once active then all structural `ng-` directives will trigger animations as they perform - * their DOM-related operations (enter, leave and move). Other directives such as `ngClass`, - * `ngShow`, `ngHide` and `ngMessages` also provide support for animations. - * - * It is recommended that the`$animate` service is always used when executing DOM-related procedures within directives. - * - * To learn more about enabling animation support, click here to visit the - * {@link ngAnimate ngAnimate module page}. - */ - return { - // we don't call it directly since non-existant arguments may - // be interpreted as null within the sub enabled function - - /** - * - * @ngdoc method - * @name $animate#on - * @kind function - * @description Sets up an event listener to fire whenever the animation event (enter, leave, move, etc...) - * has fired on the given element or among any of its children. Once the listener is fired, the provided callback - * is fired with the following params: - * - * ```js - * $animate.on('enter', container, - * function callback(element, phase) { - * // cool we detected an enter animation within the container - * } - * ); - * ``` - * - * @param {string} event the animation event that will be captured (e.g. enter, leave, move, addClass, removeClass, etc...) - * @param {DOMElement} container the container element that will capture each of the animation events that are fired on itself - * as well as among its children - * @param {Function} callback the callback function that will be fired when the listener is triggered - * - * The arguments present in the callback function are: - * * `element` - The captured DOM element that the animation was fired on. - * * `phase` - The phase of the animation. The two possible phases are **start** (when the animation starts) and **close** (when it ends). - */ - on: $$animateQueue.on, - - /** - * - * @ngdoc method - * @name $animate#off - * @kind function - * @description Deregisters an event listener based on the event which has been associated with the provided element. This method - * can be used in three different ways depending on the arguments: - * - * ```js - * // remove all the animation event listeners listening for `enter` - * $animate.off('enter'); - * - * // remove listeners for all animation events from the container element - * $animate.off(container); - * - * // remove all the animation event listeners listening for `enter` on the given element and its children - * $animate.off('enter', container); - * - * // remove the event listener function provided by `callback` that is set - * // to listen for `enter` on the given `container` as well as its children - * $animate.off('enter', container, callback); - * ``` - * - * @param {string|DOMElement} event|container the animation event (e.g. enter, leave, move, - * addClass, removeClass, etc...), or the container element. If it is the element, all other - * arguments are ignored. - * @param {DOMElement=} container the container element the event listener was placed on - * @param {Function=} callback the callback function that was registered as the listener - */ - off: $$animateQueue.off, - - /** - * @ngdoc method - * @name $animate#pin - * @kind function - * @description Associates the provided element with a host parent element to allow the element to be animated even if it exists - * outside of the DOM structure of the Angular application. By doing so, any animation triggered via `$animate` can be issued on the - * element despite being outside the realm of the application or within another application. Say for example if the application - * was bootstrapped on an element that is somewhere inside of the `` tag, but we wanted to allow for an element to be situated - * as a direct child of `document.body`, then this can be achieved by pinning the element via `$animate.pin(element)`. Keep in mind - * that calling `$animate.pin(element, parentElement)` will not actually insert into the DOM anywhere; it will just create the association. - * - * Note that this feature is only active when the `ngAnimate` module is used. - * - * @param {DOMElement} element the external element that will be pinned - * @param {DOMElement} parentElement the host parent element that will be associated with the external element - */ - pin: $$animateQueue.pin, - - /** - * - * @ngdoc method - * @name $animate#enabled - * @kind function - * @description Used to get and set whether animations are enabled or not on the entire application or on an element and its children. This - * function can be called in four ways: - * - * ```js - * // returns true or false - * $animate.enabled(); - * - * // changes the enabled state for all animations - * $animate.enabled(false); - * $animate.enabled(true); - * - * // returns true or false if animations are enabled for an element - * $animate.enabled(element); - * - * // changes the enabled state for an element and its children - * $animate.enabled(element, true); - * $animate.enabled(element, false); - * ``` - * - * @param {DOMElement=} element the element that will be considered for checking/setting the enabled state - * @param {boolean=} enabled whether or not the animations will be enabled for the element - * - * @return {boolean} whether or not animations are enabled - */ - enabled: $$animateQueue.enabled, - - /** - * @ngdoc method - * @name $animate#cancel - * @kind function - * @description Cancels the provided animation. - * - * @param {Promise} animationPromise The animation promise that is returned when an animation is started. - */ - cancel: function(runner) { - if (runner.end) { - runner.end(); - } - }, - - /** - * - * @ngdoc method - * @name $animate#enter - * @kind function - * @description Inserts the element into the DOM either after the `after` element (if provided) or - * as the first child within the `parent` element and then triggers an animation. - * A promise is returned that will be resolved during the next digest once the animation - * has completed. - * - * @param {DOMElement} element the element which will be inserted into the DOM - * @param {DOMElement} parent the parent element which will append the element as - * a child (so long as the after element is not present) - * @param {DOMElement=} after the sibling element after which the element will be appended - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - enter: function(element, parent, after, options) { - parent = parent && jqLite(parent); - after = after && jqLite(after); - parent = parent || after.parent(); - domInsert(element, parent, after); - return $$animateQueue.push(element, 'enter', prepareAnimateOptions(options)); - }, - - /** - * - * @ngdoc method - * @name $animate#move - * @kind function - * @description Inserts (moves) the element into its new position in the DOM either after - * the `after` element (if provided) or as the first child within the `parent` element - * and then triggers an animation. A promise is returned that will be resolved - * during the next digest once the animation has completed. - * - * @param {DOMElement} element the element which will be moved into the new DOM position - * @param {DOMElement} parent the parent element which will append the element as - * a child (so long as the after element is not present) - * @param {DOMElement=} after the sibling element after which the element will be appended - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - move: function(element, parent, after, options) { - parent = parent && jqLite(parent); - after = after && jqLite(after); - parent = parent || after.parent(); - domInsert(element, parent, after); - return $$animateQueue.push(element, 'move', prepareAnimateOptions(options)); - }, - - /** - * @ngdoc method - * @name $animate#leave - * @kind function - * @description Triggers an animation and then removes the element from the DOM. - * When the function is called a promise is returned that will be resolved during the next - * digest once the animation has completed. - * - * @param {DOMElement} element the element which will be removed from the DOM - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - leave: function(element, options) { - return $$animateQueue.push(element, 'leave', prepareAnimateOptions(options), function() { - element.remove(); - }); - }, - - /** - * @ngdoc method - * @name $animate#addClass - * @kind function - * - * @description Triggers an addClass animation surrounding the addition of the provided CSS class(es). Upon - * execution, the addClass operation will only be handled after the next digest and it will not trigger an - * animation if element already contains the CSS class or if the class is removed at a later step. - * Note that class-based animations are treated differently compared to structural animations - * (like enter, move and leave) since the CSS classes may be added/removed at different points - * depending if CSS or JavaScript animations are used. - * - * @param {DOMElement} element the element which the CSS classes will be applied to - * @param {string} className the CSS class(es) that will be added (multiple classes are separated via spaces) - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - addClass: function(element, className, options) { - options = prepareAnimateOptions(options); - options.addClass = mergeClasses(options.addclass, className); - return $$animateQueue.push(element, 'addClass', options); - }, - - /** - * @ngdoc method - * @name $animate#removeClass - * @kind function - * - * @description Triggers a removeClass animation surrounding the removal of the provided CSS class(es). Upon - * execution, the removeClass operation will only be handled after the next digest and it will not trigger an - * animation if element does not contain the CSS class or if the class is added at a later step. - * Note that class-based animations are treated differently compared to structural animations - * (like enter, move and leave) since the CSS classes may be added/removed at different points - * depending if CSS or JavaScript animations are used. - * - * @param {DOMElement} element the element which the CSS classes will be applied to - * @param {string} className the CSS class(es) that will be removed (multiple classes are separated via spaces) - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - removeClass: function(element, className, options) { - options = prepareAnimateOptions(options); - options.removeClass = mergeClasses(options.removeClass, className); - return $$animateQueue.push(element, 'removeClass', options); - }, - - /** - * @ngdoc method - * @name $animate#setClass - * @kind function - * - * @description Performs both the addition and removal of a CSS classes on an element and (during the process) - * triggers an animation surrounding the class addition/removal. Much like `$animate.addClass` and - * `$animate.removeClass`, `setClass` will only evaluate the classes being added/removed once a digest has - * passed. Note that class-based animations are treated differently compared to structural animations - * (like enter, move and leave) since the CSS classes may be added/removed at different points - * depending if CSS or JavaScript animations are used. - * - * @param {DOMElement} element the element which the CSS classes will be applied to - * @param {string} add the CSS class(es) that will be added (multiple classes are separated via spaces) - * @param {string} remove the CSS class(es) that will be removed (multiple classes are separated via spaces) - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - setClass: function(element, add, remove, options) { - options = prepareAnimateOptions(options); - options.addClass = mergeClasses(options.addClass, add); - options.removeClass = mergeClasses(options.removeClass, remove); - return $$animateQueue.push(element, 'setClass', options); - }, - - /** - * @ngdoc method - * @name $animate#animate - * @kind function - * - * @description Performs an inline animation on the element which applies the provided to and from CSS styles to the element. - * If any detected CSS transition, keyframe or JavaScript matches the provided className value, then the animation will take - * on the provided styles. For example, if a transition animation is set for the given className, then the provided `from` and - * `to` styles will be applied alongside the given transition. If the CSS style provided in `from` does not have a corresponding - * style in `to`, the style in `from` is applied immediately, and no animation is run. - * If a JavaScript animation is detected then the provided styles will be given in as function parameters into the `animate` - * method (or as part of the `options` parameter): - * - * ```js - * ngModule.animation('.my-inline-animation', function() { - * return { - * animate : function(element, from, to, done, options) { - * //animation - * done(); - * } - * } - * }); - * ``` - * - * @param {DOMElement} element the element which the CSS styles will be applied to - * @param {object} from the from (starting) CSS styles that will be applied to the element and across the animation. - * @param {object} to the to (destination) CSS styles that will be applied to the element and across the animation. - * @param {string=} className an optional CSS class that will be applied to the element for the duration of the animation. If - * this value is left as empty then a CSS class of `ng-inline-animate` will be applied to the element. - * (Note that if no animation is detected then this value will not be applied to the element.) - * @param {object=} options an optional collection of options/styles that will be applied to the element. - * The object can have the following properties: - * - * - **addClass** - `{string}` - space-separated CSS classes to add to element - * - **from** - `{Object}` - CSS properties & values at the beginning of animation. Must have matching `to` - * - **removeClass** - `{string}` - space-separated CSS classes to remove from element - * - **to** - `{Object}` - CSS properties & values at end of animation. Must have matching `from` - * - * @return {Promise} the animation callback promise - */ - animate: function(element, from, to, className, options) { - options = prepareAnimateOptions(options); - options.from = options.from ? extend(options.from, from) : from; - options.to = options.to ? extend(options.to, to) : to; - - className = className || 'ng-inline-animate'; - options.tempClasses = mergeClasses(options.tempClasses, className); - return $$animateQueue.push(element, 'animate', options); - } - }; - }]; -}]; - -var $$AnimateAsyncRunFactoryProvider = /** @this */ function() { - this.$get = ['$$rAF', function($$rAF) { - var waitQueue = []; - - function waitForTick(fn) { - waitQueue.push(fn); - if (waitQueue.length > 1) return; - $$rAF(function() { - for (var i = 0; i < waitQueue.length; i++) { - waitQueue[i](); - } - waitQueue = []; - }); - } - - return function() { - var passed = false; - waitForTick(function() { - passed = true; - }); - return function(callback) { - if (passed) { - callback(); - } else { - waitForTick(callback); - } - }; - }; - }]; -}; - -var $$AnimateRunnerFactoryProvider = /** @this */ function() { - this.$get = ['$q', '$sniffer', '$$animateAsyncRun', '$$isDocumentHidden', '$timeout', - function($q, $sniffer, $$animateAsyncRun, $$isDocumentHidden, $timeout) { - - var INITIAL_STATE = 0; - var DONE_PENDING_STATE = 1; - var DONE_COMPLETE_STATE = 2; - - AnimateRunner.chain = function(chain, callback) { - var index = 0; - - next(); - function next() { - if (index === chain.length) { - callback(true); - return; - } - - chain[index](function(response) { - if (response === false) { - callback(false); - return; - } - index++; - next(); - }); - } - }; - - AnimateRunner.all = function(runners, callback) { - var count = 0; - var status = true; - forEach(runners, function(runner) { - runner.done(onProgress); - }); - - function onProgress(response) { - status = status && response; - if (++count === runners.length) { - callback(status); - } - } - }; - - function AnimateRunner(host) { - this.setHost(host); - - var rafTick = $$animateAsyncRun(); - var timeoutTick = function(fn) { - $timeout(fn, 0, false); - }; - - this._doneCallbacks = []; - this._tick = function(fn) { - if ($$isDocumentHidden()) { - timeoutTick(fn); - } else { - rafTick(fn); - } - }; - this._state = 0; - } - - AnimateRunner.prototype = { - setHost: function(host) { - this.host = host || {}; - }, - - done: function(fn) { - if (this._state === DONE_COMPLETE_STATE) { - fn(); - } else { - this._doneCallbacks.push(fn); - } - }, - - progress: noop, - - getPromise: function() { - if (!this.promise) { - var self = this; - this.promise = $q(function(resolve, reject) { - self.done(function(status) { - if (status === false) { - reject(); - } else { - resolve(); - } - }); - }); - } - return this.promise; - }, - - then: function(resolveHandler, rejectHandler) { - return this.getPromise().then(resolveHandler, rejectHandler); - }, - - 'catch': function(handler) { - return this.getPromise()['catch'](handler); - }, - - 'finally': function(handler) { - return this.getPromise()['finally'](handler); - }, - - pause: function() { - if (this.host.pause) { - this.host.pause(); - } - }, - - resume: function() { - if (this.host.resume) { - this.host.resume(); - } - }, - - end: function() { - if (this.host.end) { - this.host.end(); - } - this._resolve(true); - }, - - cancel: function() { - if (this.host.cancel) { - this.host.cancel(); - } - this._resolve(false); - }, - - complete: function(response) { - var self = this; - if (self._state === INITIAL_STATE) { - self._state = DONE_PENDING_STATE; - self._tick(function() { - self._resolve(response); - }); - } - }, - - _resolve: function(response) { - if (this._state !== DONE_COMPLETE_STATE) { - forEach(this._doneCallbacks, function(fn) { - fn(response); - }); - this._doneCallbacks.length = 0; - this._state = DONE_COMPLETE_STATE; - } - } - }; - - return AnimateRunner; - }]; -}; - -/* exported $CoreAnimateCssProvider */ - -/** - * @ngdoc service - * @name $animateCss - * @kind object - * @this - * - * @description - * This is the core version of `$animateCss`. By default, only when the `ngAnimate` is included, - * then the `$animateCss` service will actually perform animations. - * - * Click here {@link ngAnimate.$animateCss to read the documentation for $animateCss}. - */ -var $CoreAnimateCssProvider = function() { - this.$get = ['$$rAF', '$q', '$$AnimateRunner', function($$rAF, $q, $$AnimateRunner) { - - return function(element, initialOptions) { - // all of the animation functions should create - // a copy of the options data, however, if a - // parent service has already created a copy then - // we should stick to using that - var options = initialOptions || {}; - if (!options.$$prepared) { - options = copy(options); - } - - // there is no point in applying the styles since - // there is no animation that goes on at all in - // this version of $animateCss. - if (options.cleanupStyles) { - options.from = options.to = null; - } - - if (options.from) { - element.css(options.from); - options.from = null; - } - - var closed, runner = new $$AnimateRunner(); - return { - start: run, - end: run - }; - - function run() { - $$rAF(function() { - applyAnimationContents(); - if (!closed) { - runner.complete(); - } - closed = true; - }); - return runner; - } - - function applyAnimationContents() { - if (options.addClass) { - element.addClass(options.addClass); - options.addClass = null; - } - if (options.removeClass) { - element.removeClass(options.removeClass); - options.removeClass = null; - } - if (options.to) { - element.css(options.to); - options.to = null; - } - } - }; - }]; -}; - -/* global stripHash: true */ - -/** - * ! This is a private undocumented service ! - * - * @name $browser - * @requires $log - * @description - * This object has two goals: - * - * - hide all the global state in the browser caused by the window object - * - abstract away all the browser specific features and inconsistencies - * - * For tests we provide {@link ngMock.$browser mock implementation} of the `$browser` - * service, which can be used for convenient testing of the application without the interaction with - * the real browser apis. - */ -/** - * @param {object} window The global window object. - * @param {object} document jQuery wrapped document. - * @param {object} $log window.console or an object with the same interface. - * @param {object} $sniffer $sniffer service - */ -function Browser(window, document, $log, $sniffer) { - var self = this, - location = window.location, - history = window.history, - setTimeout = window.setTimeout, - clearTimeout = window.clearTimeout, - pendingDeferIds = {}; - - self.isMock = false; - - var outstandingRequestCount = 0; - var outstandingRequestCallbacks = []; - - // TODO(vojta): remove this temporary api - self.$$completeOutstandingRequest = completeOutstandingRequest; - self.$$incOutstandingRequestCount = function() { outstandingRequestCount++; }; - - /** - * Executes the `fn` function(supports currying) and decrements the `outstandingRequestCallbacks` - * counter. If the counter reaches 0, all the `outstandingRequestCallbacks` are executed. - */ - function completeOutstandingRequest(fn) { - try { - fn.apply(null, sliceArgs(arguments, 1)); - } finally { - outstandingRequestCount--; - if (outstandingRequestCount === 0) { - while (outstandingRequestCallbacks.length) { - try { - outstandingRequestCallbacks.pop()(); - } catch (e) { - $log.error(e); - } - } - } - } - } - - function getHash(url) { - var index = url.indexOf('#'); - return index === -1 ? '' : url.substr(index); - } - - /** - * @private - * Note: this method is used only by scenario runner - * TODO(vojta): prefix this method with $$ ? - * @param {function()} callback Function that will be called when no outstanding request - */ - self.notifyWhenNoOutstandingRequests = function(callback) { - if (outstandingRequestCount === 0) { - callback(); - } else { - outstandingRequestCallbacks.push(callback); - } - }; - - ////////////////////////////////////////////////////////////// - // URL API - ////////////////////////////////////////////////////////////// - - var cachedState, lastHistoryState, - lastBrowserUrl = location.href, - baseElement = document.find('base'), - pendingLocation = null, - getCurrentState = !$sniffer.history ? noop : function getCurrentState() { - try { - return history.state; - } catch (e) { - // MSIE can reportedly throw when there is no state (UNCONFIRMED). - } - }; - - cacheState(); - lastHistoryState = cachedState; - - /** - * @name $browser#url - * - * @description - * GETTER: - * Without any argument, this method just returns current value of location.href. - * - * SETTER: - * With at least one argument, this method sets url to new value. - * If html5 history api supported, pushState/replaceState is used, otherwise - * location.href/location.replace is used. - * Returns its own instance to allow chaining - * - * NOTE: this api is intended for use only by the $location service. Please use the - * {@link ng.$location $location service} to change url. - * - * @param {string} url New url (when used as setter) - * @param {boolean=} replace Should new url replace current history record? - * @param {object=} state object to use with pushState/replaceState - */ - self.url = function(url, replace, state) { - // In modern browsers `history.state` is `null` by default; treating it separately - // from `undefined` would cause `$browser.url('/foo')` to change `history.state` - // to undefined via `pushState`. Instead, let's change `undefined` to `null` here. - if (isUndefined(state)) { - state = null; - } - - // Android Browser BFCache causes location, history reference to become stale. - if (location !== window.location) location = window.location; - if (history !== window.history) history = window.history; - - // setter - if (url) { - var sameState = lastHistoryState === state; - - // Don't change anything if previous and current URLs and states match. This also prevents - // IE<10 from getting into redirect loop when in LocationHashbangInHtml5Url mode. - // See https://github.com/angular/angular.js/commit/ffb2701 - if (lastBrowserUrl === url && (!$sniffer.history || sameState)) { - return self; - } - var sameBase = lastBrowserUrl && stripHash(lastBrowserUrl) === stripHash(url); - lastBrowserUrl = url; - lastHistoryState = state; - // Don't use history API if only the hash changed - // due to a bug in IE10/IE11 which leads - // to not firing a `hashchange` nor `popstate` event - // in some cases (see #9143). - if ($sniffer.history && (!sameBase || !sameState)) { - history[replace ? 'replaceState' : 'pushState'](state, '', url); - cacheState(); - // Do the assignment again so that those two variables are referentially identical. - lastHistoryState = cachedState; - } else { - if (!sameBase) { - pendingLocation = url; - } - if (replace) { - location.replace(url); - } else if (!sameBase) { - location.href = url; - } else { - location.hash = getHash(url); - } - if (location.href !== url) { - pendingLocation = url; - } - } - if (pendingLocation) { - pendingLocation = url; - } - return self; - // getter - } else { - // - pendingLocation is needed as browsers don't allow to read out - // the new location.href if a reload happened or if there is a bug like in iOS 9 (see - // https://openradar.appspot.com/22186109). - // - the replacement is a workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=407172 - return pendingLocation || location.href.replace(/%27/g,'\''); - } - }; - - /** - * @name $browser#state - * - * @description - * This method is a getter. - * - * Return history.state or null if history.state is undefined. - * - * @returns {object} state - */ - self.state = function() { - return cachedState; - }; - - var urlChangeListeners = [], - urlChangeInit = false; - - function cacheStateAndFireUrlChange() { - pendingLocation = null; - cacheState(); - fireUrlChange(); - } - - // This variable should be used *only* inside the cacheState function. - var lastCachedState = null; - function cacheState() { - // This should be the only place in $browser where `history.state` is read. - cachedState = getCurrentState(); - cachedState = isUndefined(cachedState) ? null : cachedState; - - // Prevent callbacks fo fire twice if both hashchange & popstate were fired. - if (equals(cachedState, lastCachedState)) { - cachedState = lastCachedState; - } - lastCachedState = cachedState; - } - - function fireUrlChange() { - if (lastBrowserUrl === self.url() && lastHistoryState === cachedState) { - return; - } - - lastBrowserUrl = self.url(); - lastHistoryState = cachedState; - forEach(urlChangeListeners, function(listener) { - listener(self.url(), cachedState); - }); - } - - /** - * @name $browser#onUrlChange - * - * @description - * Register callback function that will be called, when url changes. - * - * It's only called when the url is changed from outside of angular: - * - user types different url into address bar - * - user clicks on history (forward/back) button - * - user clicks on a link - * - * It's not called when url is changed by $browser.url() method - * - * The listener gets called with new url as parameter. - * - * NOTE: this api is intended for use only by the $location service. Please use the - * {@link ng.$location $location service} to monitor url changes in angular apps. - * - * @param {function(string)} listener Listener function to be called when url changes. - * @return {function(string)} Returns the registered listener fn - handy if the fn is anonymous. - */ - self.onUrlChange = function(callback) { - // TODO(vojta): refactor to use node's syntax for events - if (!urlChangeInit) { - // We listen on both (hashchange/popstate) when available, as some browsers (e.g. Opera) - // don't fire popstate when user change the address bar and don't fire hashchange when url - // changed by push/replaceState - - // html5 history api - popstate event - if ($sniffer.history) jqLite(window).on('popstate', cacheStateAndFireUrlChange); - // hashchange event - jqLite(window).on('hashchange', cacheStateAndFireUrlChange); - - urlChangeInit = true; - } - - urlChangeListeners.push(callback); - return callback; - }; - - /** - * @private - * Remove popstate and hashchange handler from window. - * - * NOTE: this api is intended for use only by $rootScope. - */ - self.$$applicationDestroyed = function() { - jqLite(window).off('hashchange popstate', cacheStateAndFireUrlChange); - }; - - /** - * Checks whether the url has changed outside of Angular. - * Needs to be exported to be able to check for changes that have been done in sync, - * as hashchange/popstate events fire in async. - */ - self.$$checkUrlChange = fireUrlChange; - - ////////////////////////////////////////////////////////////// - // Misc API - ////////////////////////////////////////////////////////////// - - /** - * @name $browser#baseHref - * - * @description - * Returns current - * (always relative - without domain) - * - * @returns {string} The current base href - */ - self.baseHref = function() { - var href = baseElement.attr('href'); - return href ? href.replace(/^(https?:)?\/\/[^/]*/, '') : ''; - }; - - /** - * @name $browser#defer - * @param {function()} fn A function, who's execution should be deferred. - * @param {number=} [delay=0] of milliseconds to defer the function execution. - * @returns {*} DeferId that can be used to cancel the task via `$browser.defer.cancel()`. - * - * @description - * Executes a fn asynchronously via `setTimeout(fn, delay)`. - * - * Unlike when calling `setTimeout` directly, in test this function is mocked and instead of using - * `setTimeout` in tests, the fns are queued in an array, which can be programmatically flushed - * via `$browser.defer.flush()`. - * - */ - self.defer = function(fn, delay) { - var timeoutId; - outstandingRequestCount++; - timeoutId = setTimeout(function() { - delete pendingDeferIds[timeoutId]; - completeOutstandingRequest(fn); - }, delay || 0); - pendingDeferIds[timeoutId] = true; - return timeoutId; - }; - - - /** - * @name $browser#defer.cancel - * - * @description - * Cancels a deferred task identified with `deferId`. - * - * @param {*} deferId Token returned by the `$browser.defer` function. - * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully - * canceled. - */ - self.defer.cancel = function(deferId) { - if (pendingDeferIds[deferId]) { - delete pendingDeferIds[deferId]; - clearTimeout(deferId); - completeOutstandingRequest(noop); - return true; - } - return false; - }; - -} - -/** @this */ -function $BrowserProvider() { - this.$get = ['$window', '$log', '$sniffer', '$document', - function($window, $log, $sniffer, $document) { - return new Browser($window, $document, $log, $sniffer); - }]; -} - -/** - * @ngdoc service - * @name $cacheFactory - * @this - * - * @description - * Factory that constructs {@link $cacheFactory.Cache Cache} objects and gives access to - * them. - * - * ```js - * - * var cache = $cacheFactory('cacheId'); - * expect($cacheFactory.get('cacheId')).toBe(cache); - * expect($cacheFactory.get('noSuchCacheId')).not.toBeDefined(); - * - * cache.put("key", "value"); - * cache.put("another key", "another value"); - * - * // We've specified no options on creation - * expect(cache.info()).toEqual({id: 'cacheId', size: 2}); - * - * ``` - * - * - * @param {string} cacheId Name or id of the newly created cache. - * @param {object=} options Options object that specifies the cache behavior. Properties: - * - * - `{number=}` `capacity` — turns the cache into LRU cache. - * - * @returns {object} Newly created cache object with the following set of methods: - * - * - `{object}` `info()` — Returns id, size, and options of cache. - * - `{{*}}` `put({string} key, {*} value)` — Puts a new key-value pair into the cache and returns - * it. - * - `{{*}}` `get({string} key)` — Returns cached value for `key` or undefined for cache miss. - * - `{void}` `remove({string} key)` — Removes a key-value pair from the cache. - * - `{void}` `removeAll()` — Removes all cached values. - * - `{void}` `destroy()` — Removes references to this cache from $cacheFactory. - * - * @example - - -
- - - - -

Cached Values

-
- - : - -
- -

Cache Info

-
- - : - -
-
- - - angular.module('cacheExampleApp', []). - controller('CacheController', ['$scope', '$cacheFactory', function($scope, $cacheFactory) { - $scope.keys = []; - $scope.cache = $cacheFactory('cacheId'); - $scope.put = function(key, value) { - if (angular.isUndefined($scope.cache.get(key))) { - $scope.keys.push(key); - } - $scope.cache.put(key, angular.isUndefined(value) ? null : value); - }; - }]); - - - p { - margin: 10px 0 3px; - } - - - */ -function $CacheFactoryProvider() { - - this.$get = function() { - var caches = {}; - - function cacheFactory(cacheId, options) { - if (cacheId in caches) { - throw minErr('$cacheFactory')('iid', 'CacheId \'{0}\' is already taken!', cacheId); - } - - var size = 0, - stats = extend({}, options, {id: cacheId}), - data = createMap(), - capacity = (options && options.capacity) || Number.MAX_VALUE, - lruHash = createMap(), - freshEnd = null, - staleEnd = null; - - /** - * @ngdoc type - * @name $cacheFactory.Cache - * - * @description - * A cache object used to store and retrieve data, primarily used by - * {@link $http $http} and the {@link ng.directive:script script} directive to cache - * templates and other data. - * - * ```js - * angular.module('superCache') - * .factory('superCache', ['$cacheFactory', function($cacheFactory) { - * return $cacheFactory('super-cache'); - * }]); - * ``` - * - * Example test: - * - * ```js - * it('should behave like a cache', inject(function(superCache) { - * superCache.put('key', 'value'); - * superCache.put('another key', 'another value'); - * - * expect(superCache.info()).toEqual({ - * id: 'super-cache', - * size: 2 - * }); - * - * superCache.remove('another key'); - * expect(superCache.get('another key')).toBeUndefined(); - * - * superCache.removeAll(); - * expect(superCache.info()).toEqual({ - * id: 'super-cache', - * size: 0 - * }); - * })); - * ``` - */ - return (caches[cacheId] = { - - /** - * @ngdoc method - * @name $cacheFactory.Cache#put - * @kind function - * - * @description - * Inserts a named entry into the {@link $cacheFactory.Cache Cache} object to be - * retrieved later, and incrementing the size of the cache if the key was not already - * present in the cache. If behaving like an LRU cache, it will also remove stale - * entries from the set. - * - * It will not insert undefined values into the cache. - * - * @param {string} key the key under which the cached data is stored. - * @param {*} value the value to store alongside the key. If it is undefined, the key - * will not be stored. - * @returns {*} the value stored. - */ - put: function(key, value) { - if (isUndefined(value)) return; - if (capacity < Number.MAX_VALUE) { - var lruEntry = lruHash[key] || (lruHash[key] = {key: key}); - - refresh(lruEntry); - } - - if (!(key in data)) size++; - data[key] = value; - - if (size > capacity) { - this.remove(staleEnd.key); - } - - return value; - }, - - /** - * @ngdoc method - * @name $cacheFactory.Cache#get - * @kind function - * - * @description - * Retrieves named data stored in the {@link $cacheFactory.Cache Cache} object. - * - * @param {string} key the key of the data to be retrieved - * @returns {*} the value stored. - */ - get: function(key) { - if (capacity < Number.MAX_VALUE) { - var lruEntry = lruHash[key]; - - if (!lruEntry) return; - - refresh(lruEntry); - } - - return data[key]; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#remove - * @kind function - * - * @description - * Removes an entry from the {@link $cacheFactory.Cache Cache} object. - * - * @param {string} key the key of the entry to be removed - */ - remove: function(key) { - if (capacity < Number.MAX_VALUE) { - var lruEntry = lruHash[key]; - - if (!lruEntry) return; - - if (lruEntry === freshEnd) freshEnd = lruEntry.p; - if (lruEntry === staleEnd) staleEnd = lruEntry.n; - link(lruEntry.n,lruEntry.p); - - delete lruHash[key]; - } - - if (!(key in data)) return; - - delete data[key]; - size--; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#removeAll - * @kind function - * - * @description - * Clears the cache object of any entries. - */ - removeAll: function() { - data = createMap(); - size = 0; - lruHash = createMap(); - freshEnd = staleEnd = null; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#destroy - * @kind function - * - * @description - * Destroys the {@link $cacheFactory.Cache Cache} object entirely, - * removing it from the {@link $cacheFactory $cacheFactory} set. - */ - destroy: function() { - data = null; - stats = null; - lruHash = null; - delete caches[cacheId]; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#info - * @kind function - * - * @description - * Retrieve information regarding a particular {@link $cacheFactory.Cache Cache}. - * - * @returns {object} an object with the following properties: - *
    - *
  • **id**: the id of the cache instance
    • - *
  • **size**: the number of entries kept in the cache instance
    • - *
  • **...**: any additional properties from the options object when creating the - * cache.
    • - *
- */ - info: function() { - return extend({}, stats, {size: size}); - } - }); - - - /** - * makes the `entry` the freshEnd of the LRU linked list - */ - function refresh(entry) { - if (entry !== freshEnd) { - if (!staleEnd) { - staleEnd = entry; - } else if (staleEnd === entry) { - staleEnd = entry.n; - } - - link(entry.n, entry.p); - link(entry, freshEnd); - freshEnd = entry; - freshEnd.n = null; - } - } - - - /** - * bidirectionally links two entries of the LRU linked list - */ - function link(nextEntry, prevEntry) { - if (nextEntry !== prevEntry) { - if (nextEntry) nextEntry.p = prevEntry; //p stands for previous, 'prev' didn't minify - if (prevEntry) prevEntry.n = nextEntry; //n stands for next, 'next' didn't minify - } - } - } - - - /** - * @ngdoc method - * @name $cacheFactory#info - * - * @description - * Get information about all the caches that have been created - * - * @returns {Object} - key-value map of `cacheId` to the result of calling `cache#info` - */ - cacheFactory.info = function() { - var info = {}; - forEach(caches, function(cache, cacheId) { - info[cacheId] = cache.info(); - }); - return info; - }; - - - /** - * @ngdoc method - * @name $cacheFactory#get - * - * @description - * Get access to a cache object by the `cacheId` used when it was created. - * - * @param {string} cacheId Name or id of a cache to access. - * @returns {object} Cache object identified by the cacheId or undefined if no such cache. - */ - cacheFactory.get = function(cacheId) { - return caches[cacheId]; - }; - - - return cacheFactory; - }; -} - -/** - * @ngdoc service - * @name $templateCache - * @this - * - * @description - * The first time a template is used, it is loaded in the template cache for quick retrieval. You - * can load templates directly into the cache in a `script` tag, or by consuming the - * `$templateCache` service directly. - * - * Adding via the `script` tag: - * - * ```html - * - * ``` - * - * **Note:** the `script` tag containing the template does not need to be included in the `head` of - * the document, but it must be a descendent of the {@link ng.$rootElement $rootElement} (IE, - * element with ng-app attribute), otherwise the template will be ignored. - * - * Adding via the `$templateCache` service: - * - * ```js - * var myApp = angular.module('myApp', []); - * myApp.run(function($templateCache) { - * $templateCache.put('templateId.html', 'This is the content of the template'); - * }); - * ``` - * - * To retrieve the template later, simply use it in your component: - * ```js - * myApp.component('myComponent', { - * templateUrl: 'templateId.html' - * }); - * ``` - * - * or get it via the `$templateCache` service: - * ```js - * $templateCache.get('templateId.html') - * ``` - * - * See {@link ng.$cacheFactory $cacheFactory}. - * - */ -function $TemplateCacheProvider() { - this.$get = ['$cacheFactory', function($cacheFactory) { - return $cacheFactory('templates'); - }]; -} - -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - * Any commits to this file should be reviewed with security in mind. * - * Changes to this file can potentially create security vulnerabilities. * - * An approval from 2 Core members with history of modifying * - * this file is required. * - * * - * Does the change somehow allow for arbitrary javascript to be executed? * - * Or allows for someone to change the prototype of built-in objects? * - * Or gives undesired access to variables like document or window? * - * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -/* ! VARIABLE/FUNCTION NAMING CONVENTIONS THAT APPLY TO THIS FILE! - * - * DOM-related variables: - * - * - "node" - DOM Node - * - "element" - DOM Element or Node - * - "$node" or "$element" - jqLite-wrapped node or element - * - * - * Compiler related stuff: - * - * - "linkFn" - linking fn of a single directive - * - "nodeLinkFn" - function that aggregates all linking fns for a particular node - * - "childLinkFn" - function that aggregates all linking fns for child nodes of a particular node - * - "compositeLinkFn" - function that aggregates all linking fns for a compilation root (nodeList) - */ - - -/** - * @ngdoc service - * @name $compile - * @kind function - * - * @description - * Compiles an HTML string or DOM into a template and produces a template function, which - * can then be used to link {@link ng.$rootScope.Scope `scope`} and the template together. - * - * The compilation is a process of walking the DOM tree and matching DOM elements to - * {@link ng.$compileProvider#directive directives}. - * - *
- * **Note:** This document is an in-depth reference of all directive options. - * For a gentle introduction to directives with examples of common use cases, - * see the {@link guide/directive directive guide}. - *
- * - * ## Comprehensive Directive API - * - * There are many different options for a directive. - * - * The difference resides in the return value of the factory function. - * You can either return a {@link $compile#directive-definition-object Directive Definition Object (see below)} - * that defines the directive properties, or just the `postLink` function (all other properties will have - * the default values). - * - *
- * **Best Practice:** It's recommended to use the "directive definition object" form. - *
- * - * Here's an example directive declared with a Directive Definition Object: - * - * ```js - * var myModule = angular.module(...); - * - * myModule.directive('directiveName', function factory(injectables) { - * var directiveDefinitionObject = { - * {@link $compile#-priority- priority}: 0, - * {@link $compile#-template- template}: '
', // or // function(tElement, tAttrs) { ... }, - * // or - * // {@link $compile#-templateurl- templateUrl}: 'directive.html', // or // function(tElement, tAttrs) { ... }, - * {@link $compile#-transclude- transclude}: false, - * {@link $compile#-restrict- restrict}: 'A', - * {@link $compile#-templatenamespace- templateNamespace}: 'html', - * {@link $compile#-scope- scope}: false, - * {@link $compile#-controller- controller}: function($scope, $element, $attrs, $transclude, otherInjectables) { ... }, - * {@link $compile#-controlleras- controllerAs}: 'stringIdentifier', - * {@link $compile#-bindtocontroller- bindToController}: false, - * {@link $compile#-require- require}: 'siblingDirectiveName', // or // ['^parentDirectiveName', '?optionalDirectiveName', '?^optionalParent'], - * {@link $compile#-multielement- multiElement}: false, - * {@link $compile#-compile- compile}: function compile(tElement, tAttrs, transclude) { - * return { - * {@link $compile#pre-linking-function pre}: function preLink(scope, iElement, iAttrs, controller) { ... }, - * {@link $compile#post-linking-function post}: function postLink(scope, iElement, iAttrs, controller) { ... } - * } - * // or - * // return function postLink( ... ) { ... } - * }, - * // or - * // {@link $compile#-link- link}: { - * // {@link $compile#pre-linking-function pre}: function preLink(scope, iElement, iAttrs, controller) { ... }, - * // {@link $compile#post-linking-function post}: function postLink(scope, iElement, iAttrs, controller) { ... } - * // } - * // or - * // {@link $compile#-link- link}: function postLink( ... ) { ... } - * }; - * return directiveDefinitionObject; - * }); - * ``` - * - *
- * **Note:** Any unspecified options will use the default value. You can see the default values below. - *
- * - * Therefore the above can be simplified as: - * - * ```js - * var myModule = angular.module(...); - * - * myModule.directive('directiveName', function factory(injectables) { - * var directiveDefinitionObject = { - * link: function postLink(scope, iElement, iAttrs) { ... } - * }; - * return directiveDefinitionObject; - * // or - * // return function postLink(scope, iElement, iAttrs) { ... } - * }); - * ``` - * - * ### Life-cycle hooks - * Directive controllers can provide the following methods that are called by Angular at points in the life-cycle of the - * directive: - * * `$onInit()` - Called on each controller after all the controllers on an element have been constructed and - * had their bindings initialized (and before the pre & post linking functions for the directives on - * this element). This is a good place to put initialization code for your controller. - * * `$onChanges(changesObj)` - Called whenever one-way (`<`) or interpolation (`@`) bindings are updated. The - * `changesObj` is a hash whose keys are the names of the bound properties that have changed, and the values are an - * object of the form `{ currentValue, previousValue, isFirstChange() }`. Use this hook to trigger updates within a - * component such as cloning the bound value to prevent accidental mutation of the outer value. - * * `$doCheck()` - Called on each turn of the digest cycle. Provides an opportunity to detect and act on - * changes. Any actions that you wish to take in response to the changes that you detect must be - * invoked from this hook; implementing this has no effect on when `$onChanges` is called. For example, this hook - * could be useful if you wish to perform a deep equality check, or to check a Date object, changes to which would not - * be detected by Angular's change detector and thus not trigger `$onChanges`. This hook is invoked with no arguments; - * if detecting changes, you must store the previous value(s) for comparison to the current values. - * * `$onDestroy()` - Called on a controller when its containing scope is destroyed. Use this hook for releasing - * external resources, watches and event handlers. Note that components have their `$onDestroy()` hooks called in - * the same order as the `$scope.$broadcast` events are triggered, which is top down. This means that parent - * components will have their `$onDestroy()` hook called before child components. - * * `$postLink()` - Called after this controller's element and its children have been linked. Similar to the post-link - * function this hook can be used to set up DOM event handlers and do direct DOM manipulation. - * Note that child elements that contain `templateUrl` directives will not have been compiled and linked since - * they are waiting for their template to load asynchronously and their own compilation and linking has been - * suspended until that occurs. - * - * #### Comparison with Angular 2 life-cycle hooks - * Angular 2 also uses life-cycle hooks for its components. While the Angular 1 life-cycle hooks are similar there are - * some differences that you should be aware of, especially when it comes to moving your code from Angular 1 to Angular 2: - * - * * Angular 1 hooks are prefixed with `$`, such as `$onInit`. Angular 2 hooks are prefixed with `ng`, such as `ngOnInit`. - * * Angular 1 hooks can be defined on the controller prototype or added to the controller inside its constructor. - * In Angular 2 you can only define hooks on the prototype of the Component class. - * * Due to the differences in change-detection, you may get many more calls to `$doCheck` in Angular 1 than you would to - * `ngDoCheck` in Angular 2 - * * Changes to the model inside `$doCheck` will trigger new turns of the digest loop, which will cause the changes to be - * propagated throughout the application. - * Angular 2 does not allow the `ngDoCheck` hook to trigger a change outside of the component. It will either throw an - * error or do nothing depending upon the state of `enableProdMode()`. - * - * #### Life-cycle hook examples - * - * This example shows how you can check for mutations to a Date object even though the identity of the object - * has not changed. - * - * - * - * angular.module('do-check-module', []) - * .component('app', { - * template: - * 'Month: ' + - * 'Date: {{ $ctrl.date }}' + - * '', - * controller: function() { - * this.date = new Date(); - * this.month = this.date.getMonth(); - * this.updateDate = function() { - * this.date.setMonth(this.month); - * }; - * } - * }) - * .component('test', { - * bindings: { date: '<' }, - * template: - * '
{{ $ctrl.log | json }}
', - * controller: function() { - * var previousValue; - * this.log = []; - * this.$doCheck = function() { - * var currentValue = this.date && this.date.valueOf(); - * if (previousValue !== currentValue) { - * this.log.push('doCheck: date mutated: ' + this.date); - * previousValue = currentValue; - * } - * }; - * } - * }); - * - * - * - * - * - * - * This example show how you might use `$doCheck` to trigger changes in your component's inputs even if the - * actual identity of the component doesn't change. (Be aware that cloning and deep equality checks on large - * arrays or objects can have a negative impact on your application performance) - * - * - * - *
- * - * - * 
{{ items }}
- * - *
- * - * - * angular.module('do-check-module', []) - * .component('test', { - * bindings: { items: '<' }, - * template: - * '
{{ $ctrl.log | json }}
', - * controller: function() { - * this.log = []; - * - * this.$doCheck = function() { - * if (this.items_ref !== this.items) { - * this.log.push('doCheck: items changed'); - * this.items_ref = this.items; - * } - * if (!angular.equals(this.items_clone, this.items)) { - * this.log.push('doCheck: items mutated'); - * this.items_clone = angular.copy(this.items); - * } - * }; - * } - * }); - * - * - * - * - * ### Directive Definition Object - * - * The directive definition object provides instructions to the {@link ng.$compile - * compiler}. The attributes are: - * - * #### `multiElement` - * When this property is set to true (default is `false`), the HTML compiler will collect DOM nodes between - * nodes with the attributes `directive-name-start` and `directive-name-end`, and group them - * together as the directive elements. It is recommended that this feature be used on directives - * which are not strictly behavioral (such as {@link ngClick}), and which - * do not manipulate or replace child nodes (such as {@link ngInclude}). - * - * #### `priority` - * When there are multiple directives defined on a single DOM element, sometimes it - * is necessary to specify the order in which the directives are applied. The `priority` is used - * to sort the directives before their `compile` functions get called. Priority is defined as a - * number. Directives with greater numerical `priority` are compiled first. Pre-link functions - * are also run in priority order, but post-link functions are run in reverse order. The order - * of directives with the same priority is undefined. The default priority is `0`. - * - * #### `terminal` - * If set to true then the current `priority` will be the last set of directives - * which will execute (any directives at the current priority will still execute - * as the order of execution on same `priority` is undefined). Note that expressions - * and other directives used in the directive's template will also be excluded from execution. - * - * #### `scope` - * The scope property can be `false`, `true`, or an object: - * - * * **`false` (default):** No scope will be created for the directive. The directive will use its - * parent's scope. - * - * * **`true`:** A new child scope that prototypically inherits from its parent will be created for - * the directive's element. If multiple directives on the same element request a new scope, - * only one new scope is created. - * - * * **`{...}` (an object hash):** A new "isolate" scope is created for the directive's element. The - * 'isolate' scope differs from normal scope in that it does not prototypically inherit from its parent - * scope. This is useful when creating reusable components, which should not accidentally read or modify - * data in the parent scope. - * - * The 'isolate' scope object hash defines a set of local scope properties derived from attributes on the - * directive's element. These local properties are useful for aliasing values for templates. The keys in - * the object hash map to the name of the property on the isolate scope; the values define how the property - * is bound to the parent scope, via matching attributes on the directive's element: - * - * * `@` or `@attr` - bind a local scope property to the value of DOM attribute. The result is - * always a string since DOM attributes are strings. If no `attr` name is specified then the - * attribute name is assumed to be the same as the local name. Given `` and the isolate scope definition `scope: { localName:'@myAttr' }`, - * the directive's scope property `localName` will reflect the interpolated value of `hello - * {{name}}`. As the `name` attribute changes so will the `localName` property on the directive's - * scope. The `name` is read from the parent scope (not the directive's scope). - * - * * `=` or `=attr` - set up a bidirectional binding between a local scope property and an expression - * passed via the attribute `attr`. The expression is evaluated in the context of the parent scope. - * If no `attr` name is specified then the attribute name is assumed to be the same as the local - * name. Given `` and the isolate scope definition `scope: { - * localModel: '=myAttr' }`, the property `localModel` on the directive's scope will reflect the - * value of `parentModel` on the parent scope. Changes to `parentModel` will be reflected in - * `localModel` and vice versa. Optional attributes should be marked as such with a question mark: - * `=?` or `=?attr`. If the binding expression is non-assignable, or if the attribute isn't - * optional and doesn't exist, an exception ({@link error/$compile/nonassign `$compile:nonassign`}) - * will be thrown upon discovering changes to the local value, since it will be impossible to sync - * them back to the parent scope. By default, the {@link ng.$rootScope.Scope#$watch `$watch`} - * method is used for tracking changes, and the equality check is based on object identity. - * However, if an object literal or an array literal is passed as the binding expression, the - * equality check is done by value (using the {@link angular.equals} function). It's also possible - * to watch the evaluated value shallowly with {@link ng.$rootScope.Scope#$watchCollection - * `$watchCollection`}: use `=*` or `=*attr` (`=*?` or `=*?attr` if the attribute is optional). - * - * * `<` or `` and directive definition of - * `scope: { localModel:'` and the isolate scope definition `scope: { - * localFn:'&myAttr' }`, the isolate scope property `localFn` will point to a function wrapper for - * the `count = count + value` expression. Often it's desirable to pass data from the isolated scope - * via an expression to the parent scope. This can be done by passing a map of local variable names - * and values into the expression wrapper fn. For example, if the expression is `increment(amount)` - * then we can specify the amount value by calling the `localFn` as `localFn({amount: 22})`. - * - * In general it's possible to apply more than one directive to one element, but there might be limitations - * depending on the type of scope required by the directives. The following points will help explain these limitations. - * For simplicity only two directives are taken into account, but it is also applicable for several directives: - * - * * **no scope** + **no scope** => Two directives which don't require their own scope will use their parent's scope - * * **child scope** + **no scope** => Both directives will share one single child scope - * * **child scope** + **child scope** => Both directives will share one single child scope - * * **isolated scope** + **no scope** => The isolated directive will use it's own created isolated scope. The other directive will use - * its parent's scope - * * **isolated scope** + **child scope** => **Won't work!** Only one scope can be related to one element. Therefore these directives cannot - * be applied to the same element. - * * **isolated scope** + **isolated scope** => **Won't work!** Only one scope can be related to one element. Therefore these directives - * cannot be applied to the same element. - * - * - * #### `bindToController` - * This property is used to bind scope properties directly to the controller. It can be either - * `true` or an object hash with the same format as the `scope` property. - * - * When an isolate scope is used for a directive (see above), `bindToController: true` will - * allow a component to have its properties bound to the controller, rather than to scope. - * - * After the controller is instantiated, the initial values of the isolate scope bindings will be bound to the controller - * properties. You can access these bindings once they have been initialized by providing a controller method called - * `$onInit`, which is called after all the controllers on an element have been constructed and had their bindings - * initialized. - * - *
- * **Deprecation warning:** although bindings for non-ES6 class controllers are currently - * bound to `this` before the controller constructor is called, this use is now deprecated. Please place initialization - * code that relies upon bindings inside a `$onInit` method on the controller, instead. - *
- * - * It is also possible to set `bindToController` to an object hash with the same format as the `scope` property. - * This will set up the scope bindings to the controller directly. Note that `scope` can still be used - * to define which kind of scope is created. By default, no scope is created. Use `scope: {}` to create an isolate - * scope (useful for component directives). - * - * If both `bindToController` and `scope` are defined and have object hashes, `bindToController` overrides `scope`. - * - * - * #### `controller` - * Controller constructor function. The controller is instantiated before the - * pre-linking phase and can be accessed by other directives (see - * `require` attribute). This allows the directives to communicate with each other and augment - * each other's behavior. The controller is injectable (and supports bracket notation) with the following locals: - * - * * `$scope` - Current scope associated with the element - * * `$element` - Current element - * * `$attrs` - Current attributes object for the element - * * `$transclude` - A transclude linking function pre-bound to the correct transclusion scope: - * `function([scope], cloneLinkingFn, futureParentElement, slotName)`: - * * `scope`: (optional) override the scope. - * * `cloneLinkingFn`: (optional) argument to create clones of the original transcluded content. - * * `futureParentElement` (optional): - * * defines the parent to which the `cloneLinkingFn` will add the cloned elements. - * * default: `$element.parent()` resp. `$element` for `transclude:'element'` resp. `transclude:true`. - * * only needed for transcludes that are allowed to contain non html elements (e.g. SVG elements) - * and when the `cloneLinkingFn` is passed, - * as those elements need to created and cloned in a special way when they are defined outside their - * usual containers (e.g. like ``). - * * See also the `directive.templateNamespace` property. - * * `slotName`: (optional) the name of the slot to transclude. If falsy (e.g. `null`, `undefined` or `''`) - * then the default transclusion is provided. - * The `$transclude` function also has a method on it, `$transclude.isSlotFilled(slotName)`, which returns - * `true` if the specified slot contains content (i.e. one or more DOM nodes). - * - * #### `require` - * Require another directive and inject its controller as the fourth argument to the linking function. The - * `require` property can be a string, an array or an object: - * * a **string** containing the name of the directive to pass to the linking function - * * an **array** containing the names of directives to pass to the linking function. The argument passed to the - * linking function will be an array of controllers in the same order as the names in the `require` property - * * an **object** whose property values are the names of the directives to pass to the linking function. The argument - * passed to the linking function will also be an object with matching keys, whose values will hold the corresponding - * controllers. - * - * If the `require` property is an object and `bindToController` is truthy, then the required controllers are - * bound to the controller using the keys of the `require` property. This binding occurs after all the controllers - * have been constructed but before `$onInit` is called. - * If the name of the required controller is the same as the local name (the key), the name can be - * omitted. For example, `{parentDir: '^^'}` is equivalent to `{parentDir: '^^parentDir'}`. - * See the {@link $compileProvider#component} helper for an example of how this can be used. - * If no such required directive(s) can be found, or if the directive does not have a controller, then an error is - * raised (unless no link function is specified and the required controllers are not being bound to the directive - * controller, in which case error checking is skipped). The name can be prefixed with: - * - * * (no prefix) - Locate the required controller on the current element. Throw an error if not found. - * * `?` - Attempt to locate the required controller or pass `null` to the `link` fn if not found. - * * `^` - Locate the required controller by searching the element and its parents. Throw an error if not found. - * * `^^` - Locate the required controller by searching the element's parents. Throw an error if not found. - * * `?^` - Attempt to locate the required controller by searching the element and its parents or pass - * `null` to the `link` fn if not found. - * * `?^^` - Attempt to locate the required controller by searching the element's parents, or pass - * `null` to the `link` fn if not found. - * - * - * #### `controllerAs` - * Identifier name for a reference to the controller in the directive's scope. - * This allows the controller to be referenced from the directive template. This is especially - * useful when a directive is used as component, i.e. with an `isolate` scope. It's also possible - * to use it in a directive without an `isolate` / `new` scope, but you need to be aware that the - * `controllerAs` reference might overwrite a property that already exists on the parent scope. - * - * - * #### `restrict` - * String of subset of `EACM` which restricts the directive to a specific directive - * declaration style. If omitted, the defaults (elements and attributes) are used. - * - * * `E` - Element name (default): `` - * * `A` - Attribute (default): `
` - * * `C` - Class: `
` - * * `M` - Comment: `` - * - * - * #### `templateNamespace` - * String representing the document type used by the markup in the template. - * AngularJS needs this information as those elements need to be created and cloned - * in a special way when they are defined outside their usual containers like `` and ``. - * - * * `html` - All root nodes in the template are HTML. Root nodes may also be - * top-level elements such as `` or ``. - * * `svg` - The root nodes in the template are SVG elements (excluding ``). - * * `math` - The root nodes in the template are MathML elements (excluding ``). - * - * If no `templateNamespace` is specified, then the namespace is considered to be `html`. - * - * #### `template` - * HTML markup that may: - * * Replace the contents of the directive's element (default). - * * Replace the directive's element itself (if `replace` is true - DEPRECATED). - * * Wrap the contents of the directive's element (if `transclude` is true). - * - * Value may be: - * - * * A string. For example `
{{delete_str}}
`. - * * A function which takes two arguments `tElement` and `tAttrs` (described in the `compile` - * function api below) and returns a string value. - * - * - * #### `templateUrl` - * This is similar to `template` but the template is loaded from the specified URL, asynchronously. - * - * Because template loading is asynchronous the compiler will suspend compilation of directives on that element - * for later when the template has been resolved. In the meantime it will continue to compile and link - * sibling and parent elements as though this element had not contained any directives. - * - * The compiler does not suspend the entire compilation to wait for templates to be loaded because this - * would result in the whole app "stalling" until all templates are loaded asynchronously - even in the - * case when only one deeply nested directive has `templateUrl`. - * - * Template loading is asynchronous even if the template has been preloaded into the {@link $templateCache} - * - * You can specify `templateUrl` as a string representing the URL or as a function which takes two - * arguments `tElement` and `tAttrs` (described in the `compile` function api below) and returns - * a string value representing the url. In either case, the template URL is passed through {@link - * $sce#getTrustedResourceUrl $sce.getTrustedResourceUrl}. - * - * - * #### `replace` ([*DEPRECATED*!], will be removed in next major release - i.e. v2.0) - * specify what the template should replace. Defaults to `false`. - * - * * `true` - the template will replace the directive's element. - * * `false` - the template will replace the contents of the directive's element. - * - * The replacement process migrates all of the attributes / classes from the old element to the new - * one. See the {@link guide/directive#template-expanding-directive - * Directives Guide} for an example. - * - * There are very few scenarios where element replacement is required for the application function, - * the main one being reusable custom components that are used within SVG contexts - * (because SVG doesn't work with custom elements in the DOM tree). - * - * #### `transclude` - * Extract the contents of the element where the directive appears and make it available to the directive. - * The contents are compiled and provided to the directive as a **transclusion function**. See the - * {@link $compile#transclusion Transclusion} section below. - * - * - * #### `compile` - * - * ```js - * function compile(tElement, tAttrs, transclude) { ... } - * ``` - * - * The compile function deals with transforming the template DOM. Since most directives do not do - * template transformation, it is not used often. The compile function takes the following arguments: - * - * * `tElement` - template element - The element where the directive has been declared. It is - * safe to do template transformation on the element and child elements only. - * - * * `tAttrs` - template attributes - Normalized list of attributes declared on this element shared - * between all directive compile functions. - * - * * `transclude` - [*DEPRECATED*!] A transclude linking function: `function(scope, cloneLinkingFn)` - * - *
- * **Note:** The template instance and the link instance may be different objects if the template has - * been cloned. For this reason it is **not** safe to do anything other than DOM transformations that - * apply to all cloned DOM nodes within the compile function. Specifically, DOM listener registration - * should be done in a linking function rather than in a compile function. - *
- - *
- * **Note:** The compile function cannot handle directives that recursively use themselves in their - * own templates or compile functions. Compiling these directives results in an infinite loop and - * stack overflow errors. - * - * This can be avoided by manually using $compile in the postLink function to imperatively compile - * a directive's template instead of relying on automatic template compilation via `template` or - * `templateUrl` declaration or manual compilation inside the compile function. - *
- * - *
- * **Note:** The `transclude` function that is passed to the compile function is deprecated, as it - * e.g. does not know about the right outer scope. Please use the transclude function that is passed - * to the link function instead. - *
- - * A compile function can have a return value which can be either a function or an object. - * - * * returning a (post-link) function - is equivalent to registering the linking function via the - * `link` property of the config object when the compile function is empty. - * - * * returning an object with function(s) registered via `pre` and `post` properties - allows you to - * control when a linking function should be called during the linking phase. See info about - * pre-linking and post-linking functions below. - * - * - * #### `link` - * This property is used only if the `compile` property is not defined. - * - * ```js - * function link(scope, iElement, iAttrs, controller, transcludeFn) { ... } - * ``` - * - * The link function is responsible for registering DOM listeners as well as updating the DOM. It is - * executed after the template has been cloned. This is where most of the directive logic will be - * put. - * - * * `scope` - {@link ng.$rootScope.Scope Scope} - The scope to be used by the - * directive for registering {@link ng.$rootScope.Scope#$watch watches}. - * - * * `iElement` - instance element - The element where the directive is to be used. It is safe to - * manipulate the children of the element only in `postLink` function since the children have - * already been linked. - * - * * `iAttrs` - instance attributes - Normalized list of attributes declared on this element shared - * between all directive linking functions. - * - * * `controller` - the directive's required controller instance(s) - Instances are shared - * among all directives, which allows the directives to use the controllers as a communication - * channel. The exact value depends on the directive's `require` property: - * * no controller(s) required: the directive's own controller, or `undefined` if it doesn't have one - * * `string`: the controller instance - * * `array`: array of controller instances - * - * If a required controller cannot be found, and it is optional, the instance is `null`, - * otherwise the {@link error:$compile:ctreq Missing Required Controller} error is thrown. - * - * Note that you can also require the directive's own controller - it will be made available like - * any other controller. - * - * * `transcludeFn` - A transclude linking function pre-bound to the correct transclusion scope. - * This is the same as the `$transclude` parameter of directive controllers, - * see {@link ng.$compile#-controller- the controller section for details}. - * `function([scope], cloneLinkingFn, futureParentElement)`. - * - * #### Pre-linking function - * - * Executed before the child elements are linked. Not safe to do DOM transformation since the - * compiler linking function will fail to locate the correct elements for linking. - * - * #### Post-linking function - * - * Executed after the child elements are linked. - * - * Note that child elements that contain `templateUrl` directives will not have been compiled - * and linked since they are waiting for their template to load asynchronously and their own - * compilation and linking has been suspended until that occurs. - * - * It is safe to do DOM transformation in the post-linking function on elements that are not waiting - * for their async templates to be resolved. - * - * - * ### Transclusion - * - * Transclusion is the process of extracting a collection of DOM elements from one part of the DOM and - * copying them to another part of the DOM, while maintaining their connection to the original AngularJS - * scope from where they were taken. - * - * Transclusion is used (often with {@link ngTransclude}) to insert the - * original contents of a directive's element into a specified place in the template of the directive. - * The benefit of transclusion, over simply moving the DOM elements manually, is that the transcluded - * content has access to the properties on the scope from which it was taken, even if the directive - * has isolated scope. - * See the {@link guide/directive#creating-a-directive-that-wraps-other-elements Directives Guide}. - * - * This makes it possible for the widget to have private state for its template, while the transcluded - * content has access to its originating scope. - * - *
- * **Note:** When testing an element transclude directive you must not place the directive at the root of the - * DOM fragment that is being compiled. See {@link guide/unit-testing#testing-transclusion-directives - * Testing Transclusion Directives}. - *
- * - * There are three kinds of transclusion depending upon whether you want to transclude just the contents of the - * directive's element, the entire element or multiple parts of the element contents: - * - * * `true` - transclude the content (i.e. the child nodes) of the directive's element. - * * `'element'` - transclude the whole of the directive's element including any directives on this - * element that defined at a lower priority than this directive. When used, the `template` - * property is ignored. - * * **`{...}` (an object hash):** - map elements of the content onto transclusion "slots" in the template. - * - * **Mult-slot transclusion** is declared by providing an object for the `transclude` property. - * - * This object is a map where the keys are the name of the slot to fill and the value is an element selector - * used to match the HTML to the slot. The element selector should be in normalized form (e.g. `myElement`) - * and will match the standard element variants (e.g. `my-element`, `my:element`, `data-my-element`, etc). - * - * For further information check out the guide on {@link guide/directive#matching-directives Matching Directives} - * - * If the element selector is prefixed with a `?` then that slot is optional. - * - * For example, the transclude object `{ slotA: '?myCustomElement' }` maps `` elements to - * the `slotA` slot, which can be accessed via the `$transclude` function or via the {@link ngTransclude} directive. - * - * Slots that are not marked as optional (`?`) will trigger a compile time error if there are no matching elements - * in the transclude content. If you wish to know if an optional slot was filled with content, then you can call - * `$transclude.isSlotFilled(slotName)` on the transclude function passed to the directive's link function and - * injectable into the directive's controller. - * - * - * #### Transclusion Functions - * - * When a directive requests transclusion, the compiler extracts its contents and provides a **transclusion - * function** to the directive's `link` function and `controller`. This transclusion function is a special - * **linking function** that will return the compiled contents linked to a new transclusion scope. - * - *
- * If you are just using {@link ngTransclude} then you don't need to worry about this function, since - * ngTransclude will deal with it for us. - *
- * - * If you want to manually control the insertion and removal of the transcluded content in your directive - * then you must use this transclude function. When you call a transclude function it returns a a jqLite/JQuery - * object that contains the compiled DOM, which is linked to the correct transclusion scope. - * - * When you call a transclusion function you can pass in a **clone attach function**. This function accepts - * two parameters, `function(clone, scope) { ... }`, where the `clone` is a fresh compiled copy of your transcluded - * content and the `scope` is the newly created transclusion scope, which the clone will be linked to. - * - *
- * **Best Practice**: Always provide a `cloneFn` (clone attach function) when you call a transclude function - * since you then get a fresh clone of the original DOM and also have access to the new transclusion scope. - *
- * - * It is normal practice to attach your transcluded content (`clone`) to the DOM inside your **clone - * attach function**: - * - * ```js - * var transcludedContent, transclusionScope; - * - * $transclude(function(clone, scope) { - * element.append(clone); - * transcludedContent = clone; - * transclusionScope = scope; - * }); - * ``` - * - * Later, if you want to remove the transcluded content from your DOM then you should also destroy the - * associated transclusion scope: - * - * ```js - * transcludedContent.remove(); - * transclusionScope.$destroy(); - * ``` - * - *
- * **Best Practice**: if you intend to add and remove transcluded content manually in your directive - * (by calling the transclude function to get the DOM and calling `element.remove()` to remove it), - * then you are also responsible for calling `$destroy` on the transclusion scope. - *
- * - * The built-in DOM manipulation directives, such as {@link ngIf}, {@link ngSwitch} and {@link ngRepeat} - * automatically destroy their transcluded clones as necessary so you do not need to worry about this if - * you are simply using {@link ngTransclude} to inject the transclusion into your directive. - * - * - * #### Transclusion Scopes - * - * When you call a transclude function it returns a DOM fragment that is pre-bound to a **transclusion - * scope**. This scope is special, in that it is a child of the directive's scope (and so gets destroyed - * when the directive's scope gets destroyed) but it inherits the properties of the scope from which it - * was taken. - * - * For example consider a directive that uses transclusion and isolated scope. The DOM hierarchy might look - * like this: - * - * ```html - *
- *
- *
- *
- *
- *
- * ``` - * - * The `$parent` scope hierarchy will look like this: - * - ``` - - $rootScope - - isolate - - transclusion - ``` - * - * but the scopes will inherit prototypically from different scopes to their `$parent`. - * - ``` - - $rootScope - - transclusion - - isolate - ``` - * - * - * ### Attributes - * - * The {@link ng.$compile.directive.Attributes Attributes} object - passed as a parameter in the - * `link()` or `compile()` functions. It has a variety of uses. - * - * * *Accessing normalized attribute names:* Directives like 'ngBind' can be expressed in many ways: - * 'ng:bind', `data-ng-bind`, or 'x-ng-bind'. The attributes object allows for normalized access - * to the attributes. - * - * * *Directive inter-communication:* All directives share the same instance of the attributes - * object which allows the directives to use the attributes object as inter directive - * communication. - * - * * *Supports interpolation:* Interpolation attributes are assigned to the attribute object - * allowing other directives to read the interpolated value. - * - * * *Observing interpolated attributes:* Use `$observe` to observe the value changes of attributes - * that contain interpolation (e.g. `src="{{bar}}"`). Not only is this very efficient but it's also - * the only way to easily get the actual value because during the linking phase the interpolation - * hasn't been evaluated yet and so the value is at this time set to `undefined`. - * - * ```js - * function linkingFn(scope, elm, attrs, ctrl) { - * // get the attribute value - * console.log(attrs.ngModel); - * - * // change the attribute - * attrs.$set('ngModel', 'new value'); - * - * // observe changes to interpolated attribute - * attrs.$observe('ngModel', function(value) { - * console.log('ngModel has changed value to ' + value); - * }); - * } - * ``` - * - * ## Example - * - *
- * **Note**: Typically directives are registered with `module.directive`. The example below is - * to illustrate how `$compile` works. - *
- * - - - -
-
-
-
-
- - - it('should auto compile', function() { - var textarea = $('textarea'); - var output = $('div[compile]'); - // The initial state reads 'Hello Angular'. - expect(output.getText()).toBe('Hello Angular'); - textarea.clear(); - textarea.sendKeys('{{name}}!'); - expect(output.getText()).toBe('Angular!'); - }); - - - - * - * - * @param {string|DOMElement} element Element or HTML string to compile into a template function. - * @param {function(angular.Scope, cloneAttachFn=)} transclude function available to directives - DEPRECATED. - * - *
- * **Note:** Passing a `transclude` function to the $compile function is deprecated, as it - * e.g. will not use the right outer scope. Please pass the transclude function as a - * `parentBoundTranscludeFn` to the link function instead. - *
- * - * @param {number} maxPriority only apply directives lower than given priority (Only effects the - * root element(s), not their children) - * @returns {function(scope, cloneAttachFn=, options=)} a link function which is used to bind template - * (a DOM element/tree) to a scope. Where: - * - * * `scope` - A {@link ng.$rootScope.Scope Scope} to bind to. - * * `cloneAttachFn` - If `cloneAttachFn` is provided, then the link function will clone the - * `template` and call the `cloneAttachFn` function allowing the caller to attach the - * cloned elements to the DOM document at the appropriate place. The `cloneAttachFn` is - * called as:
`cloneAttachFn(clonedElement, scope)` where: - * - * * `clonedElement` - is a clone of the original `element` passed into the compiler. - * * `scope` - is the current scope with which the linking function is working with. - * - * * `options` - An optional object hash with linking options. If `options` is provided, then the following - * keys may be used to control linking behavior: - * - * * `parentBoundTranscludeFn` - the transclude function made available to - * directives; if given, it will be passed through to the link functions of - * directives found in `element` during compilation. - * * `transcludeControllers` - an object hash with keys that map controller names - * to a hash with the key `instance`, which maps to the controller instance; - * if given, it will make the controllers available to directives on the compileNode: - * ``` - * { - * parent: { - * instance: parentControllerInstance - * } - * } - * ``` - * * `futureParentElement` - defines the parent to which the `cloneAttachFn` will add - * the cloned elements; only needed for transcludes that are allowed to contain non html - * elements (e.g. SVG elements). See also the directive.controller property. - * - * Calling the linking function returns the element of the template. It is either the original - * element passed in, or the clone of the element if the `cloneAttachFn` is provided. - * - * After linking the view is not updated until after a call to $digest which typically is done by - * Angular automatically. - * - * If you need access to the bound view, there are two ways to do it: - * - * - If you are not asking the linking function to clone the template, create the DOM element(s) - * before you send them to the compiler and keep this reference around. - * ```js - * var element = $compile('

{{total}}

')(scope); - * ``` - * - * - if on the other hand, you need the element to be cloned, the view reference from the original - * example would not point to the clone, but rather to the original template that was cloned. In - * this case, you can access the clone via the cloneAttachFn: - * ```js - * var templateElement = angular.element('

{{total}}

'), - * scope = ....; - * - * var clonedElement = $compile(templateElement)(scope, function(clonedElement, scope) { - * //attach the clone to DOM document at the right place - * }); - * - * //now we have reference to the cloned DOM via `clonedElement` - * ``` - * - * - * For information on how the compiler works, see the - * {@link guide/compiler Angular HTML Compiler} section of the Developer Guide. - * - * @knownIssue - * - * ### Double Compilation - * - Double compilation occurs when an already compiled part of the DOM gets - compiled again. This is an undesired effect and can lead to misbehaving directives, performance issues, - and memory leaks. Refer to the Compiler Guide {@link guide/compiler#double-compilation-and-how-to-avoid-it - section on double compilation} for an in-depth explanation and ways to avoid it. - * - */ - -var $compileMinErr = minErr('$compile'); - -function UNINITIALIZED_VALUE() {} -var _UNINITIALIZED_VALUE = new UNINITIALIZED_VALUE(); - -/** - * @ngdoc provider - * @name $compileProvider - * - * @description - */ -$CompileProvider.$inject = ['$provide', '$$sanitizeUriProvider']; -/** @this */ -function $CompileProvider($provide, $$sanitizeUriProvider) { - var hasDirectives = {}, - Suffix = 'Directive', - COMMENT_DIRECTIVE_REGEXP = /^\s*directive:\s*([\w-]+)\s+(.*)$/, - CLASS_DIRECTIVE_REGEXP = /(([\w-]+)(?::([^;]+))?;?)/, - ALL_OR_NOTHING_ATTRS = makeMap('ngSrc,ngSrcset,src,srcset'), - REQUIRE_PREFIX_REGEXP = /^(?:(\^\^?)?(\?)?(\^\^?)?)?/; - - // Ref: http://developers.whatwg.org/webappapis.html#event-handler-idl-attributes - // The assumption is that future DOM event attribute names will begin with - // 'on' and be composed of only English letters. - var EVENT_HANDLER_ATTR_REGEXP = /^(on[a-z]+|formaction)$/; - var bindingCache = createMap(); - - function parseIsolateBindings(scope, directiveName, isController) { - var LOCAL_REGEXP = /^\s*([@&<]|=(\*?))(\??)\s*(\w*)\s*$/; - - var bindings = createMap(); - - forEach(scope, function(definition, scopeName) { - if (definition in bindingCache) { - bindings[scopeName] = bindingCache[definition]; - return; - } - var match = definition.match(LOCAL_REGEXP); - - if (!match) { - throw $compileMinErr('iscp', - 'Invalid {3} for directive \'{0}\'.' + - ' Definition: {... {1}: \'{2}\' ...}', - directiveName, scopeName, definition, - (isController ? 'controller bindings definition' : - 'isolate scope definition')); - } - - bindings[scopeName] = { - mode: match[1][0], - collection: match[2] === '*', - optional: match[3] === '?', - attrName: match[4] || scopeName - }; - if (match[4]) { - bindingCache[definition] = bindings[scopeName]; - } - }); - - return bindings; - } - - function parseDirectiveBindings(directive, directiveName) { - var bindings = { - isolateScope: null, - bindToController: null - }; - if (isObject(directive.scope)) { - if (directive.bindToController === true) { - bindings.bindToController = parseIsolateBindings(directive.scope, - directiveName, true); - bindings.isolateScope = {}; - } else { - bindings.isolateScope = parseIsolateBindings(directive.scope, - directiveName, false); - } - } - if (isObject(directive.bindToController)) { - bindings.bindToController = - parseIsolateBindings(directive.bindToController, directiveName, true); - } - if (bindings.bindToController && !directive.controller) { - // There is no controller - throw $compileMinErr('noctrl', - 'Cannot bind to controller without directive \'{0}\'s controller.', - directiveName); - } - return bindings; - } - - function assertValidDirectiveName(name) { - var letter = name.charAt(0); - if (!letter || letter !== lowercase(letter)) { - throw $compileMinErr('baddir', 'Directive/Component name \'{0}\' is invalid. The first character must be a lowercase letter', name); - } - if (name !== name.trim()) { - throw $compileMinErr('baddir', - 'Directive/Component name \'{0}\' is invalid. The name should not contain leading or trailing whitespaces', - name); - } - } - - function getDirectiveRequire(directive) { - var require = directive.require || (directive.controller && directive.name); - - if (!isArray(require) && isObject(require)) { - forEach(require, function(value, key) { - var match = value.match(REQUIRE_PREFIX_REGEXP); - var name = value.substring(match[0].length); - if (!name) require[key] = match[0] + key; - }); - } - - return require; - } - - function getDirectiveRestrict(restrict, name) { - if (restrict && !(isString(restrict) && /[EACM]/.test(restrict))) { - throw $compileMinErr('badrestrict', - 'Restrict property \'{0}\' of directive \'{1}\' is invalid', - restrict, - name); - } - - return restrict || 'EA'; - } - - /** - * @ngdoc method - * @name $compileProvider#directive - * @kind function - * - * @description - * Register a new directive with the compiler. - * - * @param {string|Object} name Name of the directive in camel-case (i.e. ngBind which - * will match as ng-bind), or an object map of directives where the keys are the - * names and the values are the factories. - * @param {Function|Array} directiveFactory An injectable directive factory function. See the - * {@link guide/directive directive guide} and the {@link $compile compile API} for more info. - * @returns {ng.$compileProvider} Self for chaining. - */ - this.directive = function registerDirective(name, directiveFactory) { - assertArg(name, 'name'); - assertNotHasOwnProperty(name, 'directive'); - if (isString(name)) { - assertValidDirectiveName(name); - assertArg(directiveFactory, 'directiveFactory'); - if (!hasDirectives.hasOwnProperty(name)) { - hasDirectives[name] = []; - $provide.factory(name + Suffix, ['$injector', '$exceptionHandler', - function($injector, $exceptionHandler) { - var directives = []; - forEach(hasDirectives[name], function(directiveFactory, index) { - try { - var directive = $injector.invoke(directiveFactory); - if (isFunction(directive)) { - directive = { compile: valueFn(directive) }; - } else if (!directive.compile && directive.link) { - directive.compile = valueFn(directive.link); - } - directive.priority = directive.priority || 0; - directive.index = index; - directive.name = directive.name || name; - directive.require = getDirectiveRequire(directive); - directive.restrict = getDirectiveRestrict(directive.restrict, name); - directive.$$moduleName = directiveFactory.$$moduleName; - directives.push(directive); - } catch (e) { - $exceptionHandler(e); - } - }); - return directives; - }]); - } - hasDirectives[name].push(directiveFactory); - } else { - forEach(name, reverseParams(registerDirective)); - } - return this; - }; - - /** - * @ngdoc method - * @name $compileProvider#component - * @module ng - * @param {string} name Name of the component in camelCase (i.e. `myComp` which will match ``) - * @param {Object} options Component definition object (a simplified - * {@link ng.$compile#directive-definition-object directive definition object}), - * with the following properties (all optional): - * - * - `controller` – `{(string|function()=}` – controller constructor function that should be - * associated with newly created scope or the name of a {@link ng.$compile#-controller- - * registered controller} if passed as a string. An empty `noop` function by default. - * - `controllerAs` – `{string=}` – identifier name for to reference the controller in the component's scope. - * If present, the controller will be published to scope under the `controllerAs` name. - * If not present, this will default to be `$ctrl`. - * - `template` – `{string=|function()=}` – html template as a string or a function that - * returns an html template as a string which should be used as the contents of this component. - * Empty string by default. - * - * If `template` is a function, then it is {@link auto.$injector#invoke injected} with - * the following locals: - * - * - `$element` - Current element - * - `$attrs` - Current attributes object for the element - * - * - `templateUrl` – `{string=|function()=}` – path or function that returns a path to an html - * template that should be used as the contents of this component. - * - * If `templateUrl` is a function, then it is {@link auto.$injector#invoke injected} with - * the following locals: - * - * - `$element` - Current element - * - `$attrs` - Current attributes object for the element - * - * - `bindings` – `{object=}` – defines bindings between DOM attributes and component properties. - * Component properties are always bound to the component controller and not to the scope. - * See {@link ng.$compile#-bindtocontroller- `bindToController`}. - * - `transclude` – `{boolean=}` – whether {@link $compile#transclusion content transclusion} is enabled. - * Disabled by default. - * - `require` - `{Object=}` - requires the controllers of other directives and binds them to - * this component's controller. The object keys specify the property names under which the required - * controllers (object values) will be bound. See {@link ng.$compile#-require- `require`}. - * - `$...` – additional properties to attach to the directive factory function and the controller - * constructor function. (This is used by the component router to annotate) - * - * @returns {ng.$compileProvider} the compile provider itself, for chaining of function calls. - * @description - * Register a **component definition** with the compiler. This is a shorthand for registering a special - * type of directive, which represents a self-contained UI component in your application. Such components - * are always isolated (i.e. `scope: {}`) and are always restricted to elements (i.e. `restrict: 'E'`). - * - * Component definitions are very simple and do not require as much configuration as defining general - * directives. Component definitions usually consist only of a template and a controller backing it. - * - * In order to make the definition easier, components enforce best practices like use of `controllerAs`, - * `bindToController`. They always have **isolate scope** and are restricted to elements. - * - * Here are a few examples of how you would usually define components: - * - * ```js - * var myMod = angular.module(...); - * myMod.component('myComp', { - * template: '
My name is {{$ctrl.name}}
', - * controller: function() { - * this.name = 'shahar'; - * } - * }); - * - * myMod.component('myComp', { - * template: '
My name is {{$ctrl.name}}
', - * bindings: {name: '@'} - * }); - * - * myMod.component('myComp', { - * templateUrl: 'views/my-comp.html', - * controller: 'MyCtrl', - * controllerAs: 'ctrl', - * bindings: {name: '@'} - * }); - * - * ``` - * For more examples, and an in-depth guide, see the {@link guide/component component guide}. - * - *
- * See also {@link ng.$compileProvider#directive $compileProvider.directive()}. - */ - this.component = function registerComponent(name, options) { - var controller = options.controller || function() {}; - - function factory($injector) { - function makeInjectable(fn) { - if (isFunction(fn) || isArray(fn)) { - return /** @this */ function(tElement, tAttrs) { - return $injector.invoke(fn, this, {$element: tElement, $attrs: tAttrs}); - }; - } else { - return fn; - } - } - - var template = (!options.template && !options.templateUrl ? '' : options.template); - var ddo = { - controller: controller, - controllerAs: identifierForController(options.controller) || options.controllerAs || '$ctrl', - template: makeInjectable(template), - templateUrl: makeInjectable(options.templateUrl), - transclude: options.transclude, - scope: {}, - bindToController: options.bindings || {}, - restrict: 'E', - require: options.require - }; - - // Copy annotations (starting with $) over to the DDO - forEach(options, function(val, key) { - if (key.charAt(0) === '$') ddo[key] = val; - }); - - return ddo; - } - - // TODO(pete) remove the following `forEach` before we release 1.6.0 - // The component-router@0.2.0 looks for the annotations on the controller constructor - // Nothing in Angular looks for annotations on the factory function but we can't remove - // it from 1.5.x yet. - - // Copy any annotation properties (starting with $) over to the factory and controller constructor functions - // These could be used by libraries such as the new component router - forEach(options, function(val, key) { - if (key.charAt(0) === '$') { - factory[key] = val; - // Don't try to copy over annotations to named controller - if (isFunction(controller)) controller[key] = val; - } - }); - - factory.$inject = ['$injector']; - - return this.directive(name, factory); - }; - - - /** - * @ngdoc method - * @name $compileProvider#aHrefSanitizationWhitelist - * @kind function - * - * @description - * Retrieves or overrides the default regular expression that is used for whitelisting of safe - * urls during a[href] sanitization. - * - * The sanitization is a security measure aimed at preventing XSS attacks via html links. - * - * Any url about to be assigned to a[href] via data-binding is first normalized and turned into - * an absolute url. Afterwards, the url is matched against the `aHrefSanitizationWhitelist` - * regular expression. If a match is found, the original url is written into the dom. Otherwise, - * the absolute url is prefixed with `'unsafe:'` string and only then is it written into the DOM. - * - * @param {RegExp=} regexp New regexp to whitelist urls with. - * @returns {RegExp|ng.$compileProvider} Current RegExp if called without value or self for - * chaining otherwise. - */ - this.aHrefSanitizationWhitelist = function(regexp) { - if (isDefined(regexp)) { - $$sanitizeUriProvider.aHrefSanitizationWhitelist(regexp); - return this; - } else { - return $$sanitizeUriProvider.aHrefSanitizationWhitelist(); - } - }; - - - /** - * @ngdoc method - * @name $compileProvider#imgSrcSanitizationWhitelist - * @kind function - * - * @description - * Retrieves or overrides the default regular expression that is used for whitelisting of safe - * urls during img[src] sanitization. - * - * The sanitization is a security measure aimed at prevent XSS attacks via html links. - * - * Any url about to be assigned to img[src] via data-binding is first normalized and turned into - * an absolute url. Afterwards, the url is matched against the `imgSrcSanitizationWhitelist` - * regular expression. If a match is found, the original url is written into the dom. Otherwise, - * the absolute url is prefixed with `'unsafe:'` string and only then is it written into the DOM. - * - * @param {RegExp=} regexp New regexp to whitelist urls with. - * @returns {RegExp|ng.$compileProvider} Current RegExp if called without value or self for - * chaining otherwise. - */ - this.imgSrcSanitizationWhitelist = function(regexp) { - if (isDefined(regexp)) { - $$sanitizeUriProvider.imgSrcSanitizationWhitelist(regexp); - return this; - } else { - return $$sanitizeUriProvider.imgSrcSanitizationWhitelist(); - } - }; - - /** - * @ngdoc method - * @name $compileProvider#debugInfoEnabled - * - * @param {boolean=} enabled update the debugInfoEnabled state if provided, otherwise just return the - * current debugInfoEnabled state - * @returns {*} current value if used as getter or itself (chaining) if used as setter - * - * @kind function - * - * @description - * Call this method to enable/disable various debug runtime information in the compiler such as adding - * binding information and a reference to the current scope on to DOM elements. - * If enabled, the compiler will add the following to DOM elements that have been bound to the scope - * * `ng-binding` CSS class - * * `$binding` data property containing an array of the binding expressions - * - * You may want to disable this in production for a significant performance boost. See - * {@link guide/production#disabling-debug-data Disabling Debug Data} for more. - * - * The default value is true. - */ - var debugInfoEnabled = true; - this.debugInfoEnabled = function(enabled) { - if (isDefined(enabled)) { - debugInfoEnabled = enabled; - return this; - } - return debugInfoEnabled; - }; - - /** - * @ngdoc method - * @name $compileProvider#preAssignBindingsEnabled - * - * @param {boolean=} enabled update the preAssignBindingsEnabled state if provided, otherwise just return the - * current preAssignBindingsEnabled state - * @returns {*} current value if used as getter or itself (chaining) if used as setter - * - * @kind function - * - * @description - * Call this method to enable/disable whether directive controllers are assigned bindings before - * calling the controller's constructor. - * If enabled (true), the compiler assigns the value of each of the bindings to the - * properties of the controller object before the constructor of this object is called. - * - * If disabled (false), the compiler calls the constructor first before assigning bindings. - * - * The default value is true in Angular 1.5.x but will switch to false in Angular 1.6.x. - */ - var preAssignBindingsEnabled = false; - this.preAssignBindingsEnabled = function(enabled) { - if (isDefined(enabled)) { - preAssignBindingsEnabled = enabled; - return this; - } - return preAssignBindingsEnabled; - }; - - - var TTL = 10; - /** - * @ngdoc method - * @name $compileProvider#onChangesTtl - * @description - * - * Sets the number of times `$onChanges` hooks can trigger new changes before giving up and - * assuming that the model is unstable. - * - * The current default is 10 iterations. - * - * In complex applications it's possible that dependencies between `$onChanges` hooks and bindings will result - * in several iterations of calls to these hooks. However if an application needs more than the default 10 - * iterations to stabilize then you should investigate what is causing the model to continuously change during - * the `$onChanges` hook execution. - * - * Increasing the TTL could have performance implications, so you should not change it without proper justification. - * - * @param {number} limit The number of `$onChanges` hook iterations. - * @returns {number|object} the current limit (or `this` if called as a setter for chaining) - */ - this.onChangesTtl = function(value) { - if (arguments.length) { - TTL = value; - return this; - } - return TTL; - }; - - var commentDirectivesEnabledConfig = true; - /** - * @ngdoc method - * @name $compileProvider#commentDirectivesEnabled - * @description - * - * It indicates to the compiler - * whether or not directives on comments should be compiled. - * Defaults to `true`. - * - * Calling this function with false disables the compilation of directives - * on comments for the whole application. - * This results in a compilation performance gain, - * as the compiler doesn't have to check comments when looking for directives. - * This should however only be used if you are sure that no comment directives are used in - * the application (including any 3rd party directives). - * - * @param {boolean} enabled `false` if the compiler may ignore directives on comments - * @returns {boolean|object} the current value (or `this` if called as a setter for chaining) - */ - this.commentDirectivesEnabled = function(value) { - if (arguments.length) { - commentDirectivesEnabledConfig = value; - return this; - } - return commentDirectivesEnabledConfig; - }; - - - var cssClassDirectivesEnabledConfig = true; - /** - * @ngdoc method - * @name $compileProvider#cssClassDirectivesEnabled - * @description - * - * It indicates to the compiler - * whether or not directives on element classes should be compiled. - * Defaults to `true`. - * - * Calling this function with false disables the compilation of directives - * on element classes for the whole application. - * This results in a compilation performance gain, - * as the compiler doesn't have to check element classes when looking for directives. - * This should however only be used if you are sure that no class directives are used in - * the application (including any 3rd party directives). - * - * @param {boolean} enabled `false` if the compiler may ignore directives on element classes - * @returns {boolean|object} the current value (or `this` if called as a setter for chaining) - */ - this.cssClassDirectivesEnabled = function(value) { - if (arguments.length) { - cssClassDirectivesEnabledConfig = value; - return this; - } - return cssClassDirectivesEnabledConfig; - }; - - this.$get = [ - '$injector', '$interpolate', '$exceptionHandler', '$templateRequest', '$parse', - '$controller', '$rootScope', '$sce', '$animate', '$$sanitizeUri', - function($injector, $interpolate, $exceptionHandler, $templateRequest, $parse, - $controller, $rootScope, $sce, $animate, $$sanitizeUri) { - - var SIMPLE_ATTR_NAME = /^\w/; - var specialAttrHolder = window.document.createElement('div'); - - - var commentDirectivesEnabled = commentDirectivesEnabledConfig; - var cssClassDirectivesEnabled = cssClassDirectivesEnabledConfig; - - - var onChangesTtl = TTL; - // The onChanges hooks should all be run together in a single digest - // When changes occur, the call to trigger their hooks will be added to this queue - var onChangesQueue; - - // This function is called in a $$postDigest to trigger all the onChanges hooks in a single digest - function flushOnChangesQueue() { - try { - if (!(--onChangesTtl)) { - // We have hit the TTL limit so reset everything - onChangesQueue = undefined; - throw $compileMinErr('infchng', '{0} $onChanges() iterations reached. Aborting!\n', TTL); - } - // We must run this hook in an apply since the $$postDigest runs outside apply - $rootScope.$apply(function() { - var errors = []; - for (var i = 0, ii = onChangesQueue.length; i < ii; ++i) { - try { - onChangesQueue[i](); - } catch (e) { - errors.push(e); - } - } - // Reset the queue to trigger a new schedule next time there is a change - onChangesQueue = undefined; - if (errors.length) { - throw errors; - } - }); - } finally { - onChangesTtl++; - } - } - - - function Attributes(element, attributesToCopy) { - if (attributesToCopy) { - var keys = Object.keys(attributesToCopy); - var i, l, key; - - for (i = 0, l = keys.length; i < l; i++) { - key = keys[i]; - this[key] = attributesToCopy[key]; - } - } else { - this.$attr = {}; - } - - this.$$element = element; - } - - Attributes.prototype = { - /** - * @ngdoc method - * @name $compile.directive.Attributes#$normalize - * @kind function - * - * @description - * Converts an attribute name (e.g. dash/colon/underscore-delimited string, optionally prefixed with `x-` or - * `data-`) to its normalized, camelCase form. - * - * Also there is special case for Moz prefix starting with upper case letter. - * - * For further information check out the guide on {@link guide/directive#matching-directives Matching Directives} - * - * @param {string} name Name to normalize - */ - $normalize: directiveNormalize, - - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$addClass - * @kind function - * - * @description - * Adds the CSS class value specified by the classVal parameter to the element. If animations - * are enabled then an animation will be triggered for the class addition. - * - * @param {string} classVal The className value that will be added to the element - */ - $addClass: function(classVal) { - if (classVal && classVal.length > 0) { - $animate.addClass(this.$$element, classVal); - } - }, - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$removeClass - * @kind function - * - * @description - * Removes the CSS class value specified by the classVal parameter from the element. If - * animations are enabled then an animation will be triggered for the class removal. - * - * @param {string} classVal The className value that will be removed from the element - */ - $removeClass: function(classVal) { - if (classVal && classVal.length > 0) { - $animate.removeClass(this.$$element, classVal); - } - }, - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$updateClass - * @kind function - * - * @description - * Adds and removes the appropriate CSS class values to the element based on the difference - * between the new and old CSS class values (specified as newClasses and oldClasses). - * - * @param {string} newClasses The current CSS className value - * @param {string} oldClasses The former CSS className value - */ - $updateClass: function(newClasses, oldClasses) { - var toAdd = tokenDifference(newClasses, oldClasses); - if (toAdd && toAdd.length) { - $animate.addClass(this.$$element, toAdd); - } - - var toRemove = tokenDifference(oldClasses, newClasses); - if (toRemove && toRemove.length) { - $animate.removeClass(this.$$element, toRemove); - } - }, - - /** - * Set a normalized attribute on the element in a way such that all directives - * can share the attribute. This function properly handles boolean attributes. - * @param {string} key Normalized key. (ie ngAttribute) - * @param {string|boolean} value The value to set. If `null` attribute will be deleted. - * @param {boolean=} writeAttr If false, does not write the value to DOM element attribute. - * Defaults to true. - * @param {string=} attrName Optional none normalized name. Defaults to key. - */ - $set: function(key, value, writeAttr, attrName) { - // TODO: decide whether or not to throw an error if "class" - //is set through this function since it may cause $updateClass to - //become unstable. - - var node = this.$$element[0], - booleanKey = getBooleanAttrName(node, key), - aliasedKey = getAliasedAttrName(key), - observer = key, - nodeName; - - if (booleanKey) { - this.$$element.prop(key, value); - attrName = booleanKey; - } else if (aliasedKey) { - this[aliasedKey] = value; - observer = aliasedKey; - } - - this[key] = value; - - // translate normalized key to actual key - if (attrName) { - this.$attr[key] = attrName; - } else { - attrName = this.$attr[key]; - if (!attrName) { - this.$attr[key] = attrName = snake_case(key, '-'); - } - } - - nodeName = nodeName_(this.$$element); - - if ((nodeName === 'a' && (key === 'href' || key === 'xlinkHref')) || - (nodeName === 'img' && key === 'src')) { - // sanitize a[href] and img[src] values - this[key] = value = $$sanitizeUri(value, key === 'src'); - } else if (nodeName === 'img' && key === 'srcset' && isDefined(value)) { - // sanitize img[srcset] values - var result = ''; - - // first check if there are spaces because it's not the same pattern - var trimmedSrcset = trim(value); - // ( 999x ,| 999w ,| ,|, ) - var srcPattern = /(\s+\d+x\s*,|\s+\d+w\s*,|\s+,|,\s+)/; - var pattern = /\s/.test(trimmedSrcset) ? srcPattern : /(,)/; - - // split srcset into tuple of uri and descriptor except for the last item - var rawUris = trimmedSrcset.split(pattern); - - // for each tuples - var nbrUrisWith2parts = Math.floor(rawUris.length / 2); - for (var i = 0; i < nbrUrisWith2parts; i++) { - var innerIdx = i * 2; - // sanitize the uri - result += $$sanitizeUri(trim(rawUris[innerIdx]), true); - // add the descriptor - result += (' ' + trim(rawUris[innerIdx + 1])); - } - - // split the last item into uri and descriptor - var lastTuple = trim(rawUris[i * 2]).split(/\s/); - - // sanitize the last uri - result += $$sanitizeUri(trim(lastTuple[0]), true); - - // and add the last descriptor if any - if (lastTuple.length === 2) { - result += (' ' + trim(lastTuple[1])); - } - this[key] = value = result; - } - - if (writeAttr !== false) { - if (value === null || isUndefined(value)) { - this.$$element.removeAttr(attrName); - } else { - if (SIMPLE_ATTR_NAME.test(attrName)) { - this.$$element.attr(attrName, value); - } else { - setSpecialAttr(this.$$element[0], attrName, value); - } - } - } - - // fire observers - var $$observers = this.$$observers; - if ($$observers) { - forEach($$observers[observer], function(fn) { - try { - fn(value); - } catch (e) { - $exceptionHandler(e); - } - }); - } - }, - - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$observe - * @kind function - * - * @description - * Observes an interpolated attribute. - * - * The observer function will be invoked once during the next `$digest` following - * compilation. The observer is then invoked whenever the interpolated value - * changes. - * - * @param {string} key Normalized key. (ie ngAttribute) . - * @param {function(interpolatedValue)} fn Function that will be called whenever - the interpolated value of the attribute changes. - * See the {@link guide/interpolation#how-text-and-attribute-bindings-work Interpolation - * guide} for more info. - * @returns {function()} Returns a deregistration function for this observer. - */ - $observe: function(key, fn) { - var attrs = this, - $$observers = (attrs.$$observers || (attrs.$$observers = createMap())), - listeners = ($$observers[key] || ($$observers[key] = [])); - - listeners.push(fn); - $rootScope.$evalAsync(function() { - if (!listeners.$$inter && attrs.hasOwnProperty(key) && !isUndefined(attrs[key])) { - // no one registered attribute interpolation function, so lets call it manually - fn(attrs[key]); - } - }); - - return function() { - arrayRemove(listeners, fn); - }; - } - }; - - function setSpecialAttr(element, attrName, value) { - // Attributes names that do not start with letters (such as `(click)`) cannot be set using `setAttribute` - // so we have to jump through some hoops to get such an attribute - // https://github.com/angular/angular.js/pull/13318 - specialAttrHolder.innerHTML = ''; - var attributes = specialAttrHolder.firstChild.attributes; - var attribute = attributes[0]; - // We have to remove the attribute from its container element before we can add it to the destination element - attributes.removeNamedItem(attribute.name); - attribute.value = value; - element.attributes.setNamedItem(attribute); - } - - function safeAddClass($element, className) { - try { - $element.addClass(className); - } catch (e) { - // ignore, since it means that we are trying to set class on - // SVG element, where class name is read-only. - } - } - - - var startSymbol = $interpolate.startSymbol(), - endSymbol = $interpolate.endSymbol(), - denormalizeTemplate = (startSymbol === '{{' && endSymbol === '}}') - ? identity - : function denormalizeTemplate(template) { - return template.replace(/\{\{/g, startSymbol).replace(/}}/g, endSymbol); - }, - NG_ATTR_BINDING = /^ngAttr[A-Z]/; - var MULTI_ELEMENT_DIR_RE = /^(.+)Start$/; - - compile.$$addBindingInfo = debugInfoEnabled ? function $$addBindingInfo($element, binding) { - var bindings = $element.data('$binding') || []; - - if (isArray(binding)) { - bindings = bindings.concat(binding); - } else { - bindings.push(binding); - } - - $element.data('$binding', bindings); - } : noop; - - compile.$$addBindingClass = debugInfoEnabled ? function $$addBindingClass($element) { - safeAddClass($element, 'ng-binding'); - } : noop; - - compile.$$addScopeInfo = debugInfoEnabled ? function $$addScopeInfo($element, scope, isolated, noTemplate) { - var dataName = isolated ? (noTemplate ? '$isolateScopeNoTemplate' : '$isolateScope') : '$scope'; - $element.data(dataName, scope); - } : noop; - - compile.$$addScopeClass = debugInfoEnabled ? function $$addScopeClass($element, isolated) { - safeAddClass($element, isolated ? 'ng-isolate-scope' : 'ng-scope'); - } : noop; - - compile.$$createComment = function(directiveName, comment) { - var content = ''; - if (debugInfoEnabled) { - content = ' ' + (directiveName || '') + ': '; - if (comment) content += comment + ' '; - } - return window.document.createComment(content); - }; - - return compile; - - //================================ - - function compile($compileNodes, transcludeFn, maxPriority, ignoreDirective, - previousCompileContext) { - if (!($compileNodes instanceof jqLite)) { - // jquery always rewraps, whereas we need to preserve the original selector so that we can - // modify it. - $compileNodes = jqLite($compileNodes); - } - var compositeLinkFn = - compileNodes($compileNodes, transcludeFn, $compileNodes, - maxPriority, ignoreDirective, previousCompileContext); - compile.$$addScopeClass($compileNodes); - var namespace = null; - return function publicLinkFn(scope, cloneConnectFn, options) { - if (!$compileNodes) { - throw $compileMinErr('multilink', 'This element has already been linked.'); - } - assertArg(scope, 'scope'); - - if (previousCompileContext && previousCompileContext.needsNewScope) { - // A parent directive did a replace and a directive on this element asked - // for transclusion, which caused us to lose a layer of element on which - // we could hold the new transclusion scope, so we will create it manually - // here. - scope = scope.$parent.$new(); - } - - options = options || {}; - var parentBoundTranscludeFn = options.parentBoundTranscludeFn, - transcludeControllers = options.transcludeControllers, - futureParentElement = options.futureParentElement; - - // When `parentBoundTranscludeFn` is passed, it is a - // `controllersBoundTransclude` function (it was previously passed - // as `transclude` to directive.link) so we must unwrap it to get - // its `boundTranscludeFn` - if (parentBoundTranscludeFn && parentBoundTranscludeFn.$$boundTransclude) { - parentBoundTranscludeFn = parentBoundTranscludeFn.$$boundTransclude; - } - - if (!namespace) { - namespace = detectNamespaceForChildElements(futureParentElement); - } - var $linkNode; - if (namespace !== 'html') { - // When using a directive with replace:true and templateUrl the $compileNodes - // (or a child element inside of them) - // might change, so we need to recreate the namespace adapted compileNodes - // for call to the link function. - // Note: This will already clone the nodes... - $linkNode = jqLite( - wrapTemplate(namespace, jqLite('
').append($compileNodes).html()) - ); - } else if (cloneConnectFn) { - // important!!: we must call our jqLite.clone() since the jQuery one is trying to be smart - // and sometimes changes the structure of the DOM. - $linkNode = JQLitePrototype.clone.call($compileNodes); - } else { - $linkNode = $compileNodes; - } - - if (transcludeControllers) { - for (var controllerName in transcludeControllers) { - $linkNode.data('$' + controllerName + 'Controller', transcludeControllers[controllerName].instance); - } - } - - compile.$$addScopeInfo($linkNode, scope); - - if (cloneConnectFn) cloneConnectFn($linkNode, scope); - if (compositeLinkFn) compositeLinkFn(scope, $linkNode, $linkNode, parentBoundTranscludeFn); - - if (!cloneConnectFn) { - $compileNodes = compositeLinkFn = null; - } - return $linkNode; - }; - } - - function detectNamespaceForChildElements(parentElement) { - // TODO: Make this detect MathML as well... - var node = parentElement && parentElement[0]; - if (!node) { - return 'html'; - } else { - return nodeName_(node) !== 'foreignobject' && toString.call(node).match(/SVG/) ? 'svg' : 'html'; - } - } - - /** - * Compile function matches each node in nodeList against the directives. Once all directives - * for a particular node are collected their compile functions are executed. The compile - * functions return values - the linking functions - are combined into a composite linking - * function, which is the a linking function for the node. - * - * @param {NodeList} nodeList an array of nodes or NodeList to compile - * @param {function(angular.Scope, cloneAttachFn=)} transcludeFn A linking function, where the - * scope argument is auto-generated to the new child of the transcluded parent scope. - * @param {DOMElement=} $rootElement If the nodeList is the root of the compilation tree then - * the rootElement must be set the jqLite collection of the compile root. This is - * needed so that the jqLite collection items can be replaced with widgets. - * @param {number=} maxPriority Max directive priority. - * @returns {Function} A composite linking function of all of the matched directives or null. - */ - function compileNodes(nodeList, transcludeFn, $rootElement, maxPriority, ignoreDirective, - previousCompileContext) { - var linkFns = [], - // `nodeList` can be either an element's `.childNodes` (live NodeList) - // or a jqLite/jQuery collection or an array - notLiveList = isArray(nodeList) || (nodeList instanceof jqLite), - attrs, directives, nodeLinkFn, childNodes, childLinkFn, linkFnFound, nodeLinkFnFound; - - - for (var i = 0; i < nodeList.length; i++) { - attrs = new Attributes(); - - // Support: IE 11 only - // Workaround for #11781 and #14924 - if (msie === 11) { - mergeConsecutiveTextNodes(nodeList, i, notLiveList); - } - - // We must always refer to `nodeList[i]` hereafter, - // since the nodes can be replaced underneath us. - directives = collectDirectives(nodeList[i], [], attrs, i === 0 ? maxPriority : undefined, - ignoreDirective); - - nodeLinkFn = (directives.length) - ? applyDirectivesToNode(directives, nodeList[i], attrs, transcludeFn, $rootElement, - null, [], [], previousCompileContext) - : null; - - if (nodeLinkFn && nodeLinkFn.scope) { - compile.$$addScopeClass(attrs.$$element); - } - - childLinkFn = (nodeLinkFn && nodeLinkFn.terminal || - !(childNodes = nodeList[i].childNodes) || - !childNodes.length) - ? null - : compileNodes(childNodes, - nodeLinkFn ? ( - (nodeLinkFn.transcludeOnThisElement || !nodeLinkFn.templateOnThisElement) - && nodeLinkFn.transclude) : transcludeFn); - - if (nodeLinkFn || childLinkFn) { - linkFns.push(i, nodeLinkFn, childLinkFn); - linkFnFound = true; - nodeLinkFnFound = nodeLinkFnFound || nodeLinkFn; - } - - //use the previous context only for the first element in the virtual group - previousCompileContext = null; - } - - // return a linking function if we have found anything, null otherwise - return linkFnFound ? compositeLinkFn : null; - - function compositeLinkFn(scope, nodeList, $rootElement, parentBoundTranscludeFn) { - var nodeLinkFn, childLinkFn, node, childScope, i, ii, idx, childBoundTranscludeFn; - var stableNodeList; - - - if (nodeLinkFnFound) { - // copy nodeList so that if a nodeLinkFn removes or adds an element at this DOM level our - // offsets don't get screwed up - var nodeListLength = nodeList.length; - stableNodeList = new Array(nodeListLength); - - // create a sparse array by only copying the elements which have a linkFn - for (i = 0; i < linkFns.length; i += 3) { - idx = linkFns[i]; - stableNodeList[idx] = nodeList[idx]; - } - } else { - stableNodeList = nodeList; - } - - for (i = 0, ii = linkFns.length; i < ii;) { - node = stableNodeList[linkFns[i++]]; - nodeLinkFn = linkFns[i++]; - childLinkFn = linkFns[i++]; - - if (nodeLinkFn) { - if (nodeLinkFn.scope) { - childScope = scope.$new(); - compile.$$addScopeInfo(jqLite(node), childScope); - } else { - childScope = scope; - } - - if (nodeLinkFn.transcludeOnThisElement) { - childBoundTranscludeFn = createBoundTranscludeFn( - scope, nodeLinkFn.transclude, parentBoundTranscludeFn); - - } else if (!nodeLinkFn.templateOnThisElement && parentBoundTranscludeFn) { - childBoundTranscludeFn = parentBoundTranscludeFn; - - } else if (!parentBoundTranscludeFn && transcludeFn) { - childBoundTranscludeFn = createBoundTranscludeFn(scope, transcludeFn); - - } else { - childBoundTranscludeFn = null; - } - - nodeLinkFn(childLinkFn, childScope, node, $rootElement, childBoundTranscludeFn); - - } else if (childLinkFn) { - childLinkFn(scope, node.childNodes, undefined, parentBoundTranscludeFn); - } - } - } - } - - function mergeConsecutiveTextNodes(nodeList, idx, notLiveList) { - var node = nodeList[idx]; - var parent = node.parentNode; - var sibling; - - if (node.nodeType !== NODE_TYPE_TEXT) { - return; - } - - while (true) { - sibling = parent ? node.nextSibling : nodeList[idx + 1]; - if (!sibling || sibling.nodeType !== NODE_TYPE_TEXT) { - break; - } - - node.nodeValue = node.nodeValue + sibling.nodeValue; - - if (sibling.parentNode) { - sibling.parentNode.removeChild(sibling); - } - if (notLiveList && sibling === nodeList[idx + 1]) { - nodeList.splice(idx + 1, 1); - } - } - } - - function createBoundTranscludeFn(scope, transcludeFn, previousBoundTranscludeFn) { - function boundTranscludeFn(transcludedScope, cloneFn, controllers, futureParentElement, containingScope) { - - if (!transcludedScope) { - transcludedScope = scope.$new(false, containingScope); - transcludedScope.$$transcluded = true; - } - - return transcludeFn(transcludedScope, cloneFn, { - parentBoundTranscludeFn: previousBoundTranscludeFn, - transcludeControllers: controllers, - futureParentElement: futureParentElement - }); - } - - // We need to attach the transclusion slots onto the `boundTranscludeFn` - // so that they are available inside the `controllersBoundTransclude` function - var boundSlots = boundTranscludeFn.$$slots = createMap(); - for (var slotName in transcludeFn.$$slots) { - if (transcludeFn.$$slots[slotName]) { - boundSlots[slotName] = createBoundTranscludeFn(scope, transcludeFn.$$slots[slotName], previousBoundTranscludeFn); - } else { - boundSlots[slotName] = null; - } - } - - return boundTranscludeFn; - } - - /** - * Looks for directives on the given node and adds them to the directive collection which is - * sorted. - * - * @param node Node to search. - * @param directives An array to which the directives are added to. This array is sorted before - * the function returns. - * @param attrs The shared attrs object which is used to populate the normalized attributes. - * @param {number=} maxPriority Max directive priority. - */ - function collectDirectives(node, directives, attrs, maxPriority, ignoreDirective) { - var nodeType = node.nodeType, - attrsMap = attrs.$attr, - match, - nodeName, - className; - - switch (nodeType) { - case NODE_TYPE_ELEMENT: /* Element */ - - nodeName = nodeName_(node); - - // use the node name: - addDirective(directives, - directiveNormalize(nodeName), 'E', maxPriority, ignoreDirective); - - // iterate over the attributes - for (var attr, name, nName, ngAttrName, value, isNgAttr, nAttrs = node.attributes, - j = 0, jj = nAttrs && nAttrs.length; j < jj; j++) { - var attrStartName = false; - var attrEndName = false; - - attr = nAttrs[j]; - name = attr.name; - value = attr.value; - - // support ngAttr attribute binding - ngAttrName = directiveNormalize(name); - isNgAttr = NG_ATTR_BINDING.test(ngAttrName); - if (isNgAttr) { - name = name.replace(PREFIX_REGEXP, '') - .substr(8).replace(/_(.)/g, function(match, letter) { - return letter.toUpperCase(); - }); - } - - var multiElementMatch = ngAttrName.match(MULTI_ELEMENT_DIR_RE); - if (multiElementMatch && directiveIsMultiElement(multiElementMatch[1])) { - attrStartName = name; - attrEndName = name.substr(0, name.length - 5) + 'end'; - name = name.substr(0, name.length - 6); - } - - nName = directiveNormalize(name.toLowerCase()); - attrsMap[nName] = name; - if (isNgAttr || !attrs.hasOwnProperty(nName)) { - attrs[nName] = value; - if (getBooleanAttrName(node, nName)) { - attrs[nName] = true; // presence means true - } - } - addAttrInterpolateDirective(node, directives, value, nName, isNgAttr); - addDirective(directives, nName, 'A', maxPriority, ignoreDirective, attrStartName, - attrEndName); - } - - if (nodeName === 'input' && node.getAttribute('type') === 'hidden') { - // Hidden input elements can have strange behaviour when navigating back to the page - // This tells the browser not to try to cache and reinstate previous values - node.setAttribute('autocomplete', 'off'); - } - - // use class as directive - if (!cssClassDirectivesEnabled) break; - className = node.className; - if (isObject(className)) { - // Maybe SVGAnimatedString - className = className.animVal; - } - if (isString(className) && className !== '') { - while ((match = CLASS_DIRECTIVE_REGEXP.exec(className))) { - nName = directiveNormalize(match[2]); - if (addDirective(directives, nName, 'C', maxPriority, ignoreDirective)) { - attrs[nName] = trim(match[3]); - } - className = className.substr(match.index + match[0].length); - } - } - break; - case NODE_TYPE_TEXT: /* Text Node */ - addTextInterpolateDirective(directives, node.nodeValue); - break; - case NODE_TYPE_COMMENT: /* Comment */ - if (!commentDirectivesEnabled) break; - collectCommentDirectives(node, directives, attrs, maxPriority, ignoreDirective); - break; - } - - directives.sort(byPriority); - return directives; - } - - function collectCommentDirectives(node, directives, attrs, maxPriority, ignoreDirective) { - // function created because of performance, try/catch disables - // the optimization of the whole function #14848 - try { - var match = COMMENT_DIRECTIVE_REGEXP.exec(node.nodeValue); - if (match) { - var nName = directiveNormalize(match[1]); - if (addDirective(directives, nName, 'M', maxPriority, ignoreDirective)) { - attrs[nName] = trim(match[2]); - } - } - } catch (e) { - // turns out that under some circumstances IE9 throws errors when one attempts to read - // comment's node value. - // Just ignore it and continue. (Can't seem to reproduce in test case.) - } - } - - /** - * Given a node with a directive-start it collects all of the siblings until it finds - * directive-end. - * @param node - * @param attrStart - * @param attrEnd - * @returns {*} - */ - function groupScan(node, attrStart, attrEnd) { - var nodes = []; - var depth = 0; - if (attrStart && node.hasAttribute && node.hasAttribute(attrStart)) { - do { - if (!node) { - throw $compileMinErr('uterdir', - 'Unterminated attribute, found \'{0}\' but no matching \'{1}\' found.', - attrStart, attrEnd); - } - if (node.nodeType === NODE_TYPE_ELEMENT) { - if (node.hasAttribute(attrStart)) depth++; - if (node.hasAttribute(attrEnd)) depth--; - } - nodes.push(node); - node = node.nextSibling; - } while (depth > 0); - } else { - nodes.push(node); - } - - return jqLite(nodes); - } - - /** - * Wrapper for linking function which converts normal linking function into a grouped - * linking function. - * @param linkFn - * @param attrStart - * @param attrEnd - * @returns {Function} - */ - function groupElementsLinkFnWrapper(linkFn, attrStart, attrEnd) { - return function groupedElementsLink(scope, element, attrs, controllers, transcludeFn) { - element = groupScan(element[0], attrStart, attrEnd); - return linkFn(scope, element, attrs, controllers, transcludeFn); - }; - } - - /** - * A function generator that is used to support both eager and lazy compilation - * linking function. - * @param eager - * @param $compileNodes - * @param transcludeFn - * @param maxPriority - * @param ignoreDirective - * @param previousCompileContext - * @returns {Function} - */ - function compilationGenerator(eager, $compileNodes, transcludeFn, maxPriority, ignoreDirective, previousCompileContext) { - var compiled; - - if (eager) { - return compile($compileNodes, transcludeFn, maxPriority, ignoreDirective, previousCompileContext); - } - return /** @this */ function lazyCompilation() { - if (!compiled) { - compiled = compile($compileNodes, transcludeFn, maxPriority, ignoreDirective, previousCompileContext); - - // Null out all of these references in order to make them eligible for garbage collection - // since this is a potentially long lived closure - $compileNodes = transcludeFn = previousCompileContext = null; - } - return compiled.apply(this, arguments); - }; - } - - /** - * Once the directives have been collected, their compile functions are executed. This method - * is responsible for inlining directive templates as well as terminating the application - * of the directives if the terminal directive has been reached. - * - * @param {Array} directives Array of collected directives to execute their compile function. - * this needs to be pre-sorted by priority order. - * @param {Node} compileNode The raw DOM node to apply the compile functions to - * @param {Object} templateAttrs The shared attribute function - * @param {function(angular.Scope, cloneAttachFn=)} transcludeFn A linking function, where the - * scope argument is auto-generated to the new - * child of the transcluded parent scope. - * @param {JQLite} jqCollection If we are working on the root of the compile tree then this - * argument has the root jqLite array so that we can replace nodes - * on it. - * @param {Object=} originalReplaceDirective An optional directive that will be ignored when - * compiling the transclusion. - * @param {Array.} preLinkFns - * @param {Array.} postLinkFns - * @param {Object} previousCompileContext Context used for previous compilation of the current - * node - * @returns {Function} linkFn - */ - function applyDirectivesToNode(directives, compileNode, templateAttrs, transcludeFn, - jqCollection, originalReplaceDirective, preLinkFns, postLinkFns, - previousCompileContext) { - previousCompileContext = previousCompileContext || {}; - - var terminalPriority = -Number.MAX_VALUE, - newScopeDirective = previousCompileContext.newScopeDirective, - controllerDirectives = previousCompileContext.controllerDirectives, - newIsolateScopeDirective = previousCompileContext.newIsolateScopeDirective, - templateDirective = previousCompileContext.templateDirective, - nonTlbTranscludeDirective = previousCompileContext.nonTlbTranscludeDirective, - hasTranscludeDirective = false, - hasTemplate = false, - hasElementTranscludeDirective = previousCompileContext.hasElementTranscludeDirective, - $compileNode = templateAttrs.$$element = jqLite(compileNode), - directive, - directiveName, - $template, - replaceDirective = originalReplaceDirective, - childTranscludeFn = transcludeFn, - linkFn, - didScanForMultipleTransclusion = false, - mightHaveMultipleTransclusionError = false, - directiveValue; - - // executes all directives on the current element - for (var i = 0, ii = directives.length; i < ii; i++) { - directive = directives[i]; - var attrStart = directive.$$start; - var attrEnd = directive.$$end; - - // collect multiblock sections - if (attrStart) { - $compileNode = groupScan(compileNode, attrStart, attrEnd); - } - $template = undefined; - - if (terminalPriority > directive.priority) { - break; // prevent further processing of directives - } - - directiveValue = directive.scope; - - if (directiveValue) { - - // skip the check for directives with async templates, we'll check the derived sync - // directive when the template arrives - if (!directive.templateUrl) { - if (isObject(directiveValue)) { - // This directive is trying to add an isolated scope. - // Check that there is no scope of any kind already - assertNoDuplicate('new/isolated scope', newIsolateScopeDirective || newScopeDirective, - directive, $compileNode); - newIsolateScopeDirective = directive; - } else { - // This directive is trying to add a child scope. - // Check that there is no isolated scope already - assertNoDuplicate('new/isolated scope', newIsolateScopeDirective, directive, - $compileNode); - } - } - - newScopeDirective = newScopeDirective || directive; - } - - directiveName = directive.name; - - // If we encounter a condition that can result in transclusion on the directive, - // then scan ahead in the remaining directives for others that may cause a multiple - // transclusion error to be thrown during the compilation process. If a matching directive - // is found, then we know that when we encounter a transcluded directive, we need to eagerly - // compile the `transclude` function rather than doing it lazily in order to throw - // exceptions at the correct time - if (!didScanForMultipleTransclusion && ((directive.replace && (directive.templateUrl || directive.template)) - || (directive.transclude && !directive.$$tlb))) { - var candidateDirective; - - for (var scanningIndex = i + 1; (candidateDirective = directives[scanningIndex++]);) { - if ((candidateDirective.transclude && !candidateDirective.$$tlb) - || (candidateDirective.replace && (candidateDirective.templateUrl || candidateDirective.template))) { - mightHaveMultipleTransclusionError = true; - break; - } - } - - didScanForMultipleTransclusion = true; - } - - if (!directive.templateUrl && directive.controller) { - controllerDirectives = controllerDirectives || createMap(); - assertNoDuplicate('\'' + directiveName + '\' controller', - controllerDirectives[directiveName], directive, $compileNode); - controllerDirectives[directiveName] = directive; - } - - directiveValue = directive.transclude; - - if (directiveValue) { - hasTranscludeDirective = true; - - // Special case ngIf and ngRepeat so that we don't complain about duplicate transclusion. - // This option should only be used by directives that know how to safely handle element transclusion, - // where the transcluded nodes are added or replaced after linking. - if (!directive.$$tlb) { - assertNoDuplicate('transclusion', nonTlbTranscludeDirective, directive, $compileNode); - nonTlbTranscludeDirective = directive; - } - - if (directiveValue === 'element') { - hasElementTranscludeDirective = true; - terminalPriority = directive.priority; - $template = $compileNode; - $compileNode = templateAttrs.$$element = - jqLite(compile.$$createComment(directiveName, templateAttrs[directiveName])); - compileNode = $compileNode[0]; - replaceWith(jqCollection, sliceArgs($template), compileNode); - - // Support: Chrome < 50 - // https://github.com/angular/angular.js/issues/14041 - - // In the versions of V8 prior to Chrome 50, the document fragment that is created - // in the `replaceWith` function is improperly garbage collected despite still - // being referenced by the `parentNode` property of all of the child nodes. By adding - // a reference to the fragment via a different property, we can avoid that incorrect - // behavior. - // TODO: remove this line after Chrome 50 has been released - $template[0].$$parentNode = $template[0].parentNode; - - childTranscludeFn = compilationGenerator(mightHaveMultipleTransclusionError, $template, transcludeFn, terminalPriority, - replaceDirective && replaceDirective.name, { - // Don't pass in: - // - controllerDirectives - otherwise we'll create duplicates controllers - // - newIsolateScopeDirective or templateDirective - combining templates with - // element transclusion doesn't make sense. - // - // We need only nonTlbTranscludeDirective so that we prevent putting transclusion - // on the same element more than once. - nonTlbTranscludeDirective: nonTlbTranscludeDirective - }); - } else { - - var slots = createMap(); - - if (!isObject(directiveValue)) { - $template = jqLite(jqLiteClone(compileNode)).contents(); - } else { - - // We have transclusion slots, - // collect them up, compile them and store their transclusion functions - $template = []; - - var slotMap = createMap(); - var filledSlots = createMap(); - - // Parse the element selectors - forEach(directiveValue, function(elementSelector, slotName) { - // If an element selector starts with a ? then it is optional - var optional = (elementSelector.charAt(0) === '?'); - elementSelector = optional ? elementSelector.substring(1) : elementSelector; - - slotMap[elementSelector] = slotName; - - // We explicitly assign `null` since this implies that a slot was defined but not filled. - // Later when calling boundTransclusion functions with a slot name we only error if the - // slot is `undefined` - slots[slotName] = null; - - // filledSlots contains `true` for all slots that are either optional or have been - // filled. This is used to check that we have not missed any required slots - filledSlots[slotName] = optional; - }); - - // Add the matching elements into their slot - forEach($compileNode.contents(), function(node) { - var slotName = slotMap[directiveNormalize(nodeName_(node))]; - if (slotName) { - filledSlots[slotName] = true; - slots[slotName] = slots[slotName] || []; - slots[slotName].push(node); - } else { - $template.push(node); - } - }); - - // Check for required slots that were not filled - forEach(filledSlots, function(filled, slotName) { - if (!filled) { - throw $compileMinErr('reqslot', 'Required transclusion slot `{0}` was not filled.', slotName); - } - }); - - for (var slotName in slots) { - if (slots[slotName]) { - // Only define a transclusion function if the slot was filled - slots[slotName] = compilationGenerator(mightHaveMultipleTransclusionError, slots[slotName], transcludeFn); - } - } - } - - $compileNode.empty(); // clear contents - childTranscludeFn = compilationGenerator(mightHaveMultipleTransclusionError, $template, transcludeFn, undefined, - undefined, { needsNewScope: directive.$$isolateScope || directive.$$newScope}); - childTranscludeFn.$$slots = slots; - } - } - - if (directive.template) { - hasTemplate = true; - assertNoDuplicate('template', templateDirective, directive, $compileNode); - templateDirective = directive; - - directiveValue = (isFunction(directive.template)) - ? directive.template($compileNode, templateAttrs) - : directive.template; - - directiveValue = denormalizeTemplate(directiveValue); - - if (directive.replace) { - replaceDirective = directive; - if (jqLiteIsTextNode(directiveValue)) { - $template = []; - } else { - $template = removeComments(wrapTemplate(directive.templateNamespace, trim(directiveValue))); - } - compileNode = $template[0]; - - if ($template.length !== 1 || compileNode.nodeType !== NODE_TYPE_ELEMENT) { - throw $compileMinErr('tplrt', - 'Template for directive \'{0}\' must have exactly one root element. {1}', - directiveName, ''); - } - - replaceWith(jqCollection, $compileNode, compileNode); - - var newTemplateAttrs = {$attr: {}}; - - // combine directives from the original node and from the template: - // - take the array of directives for this element - // - split it into two parts, those that already applied (processed) and those that weren't (unprocessed) - // - collect directives from the template and sort them by priority - // - combine directives as: processed + template + unprocessed - var templateDirectives = collectDirectives(compileNode, [], newTemplateAttrs); - var unprocessedDirectives = directives.splice(i + 1, directives.length - (i + 1)); - - if (newIsolateScopeDirective || newScopeDirective) { - // The original directive caused the current element to be replaced but this element - // also needs to have a new scope, so we need to tell the template directives - // that they would need to get their scope from further up, if they require transclusion - markDirectiveScope(templateDirectives, newIsolateScopeDirective, newScopeDirective); - } - directives = directives.concat(templateDirectives).concat(unprocessedDirectives); - mergeTemplateAttributes(templateAttrs, newTemplateAttrs); - - ii = directives.length; - } else { - $compileNode.html(directiveValue); - } - } - - if (directive.templateUrl) { - hasTemplate = true; - assertNoDuplicate('template', templateDirective, directive, $compileNode); - templateDirective = directive; - - if (directive.replace) { - replaceDirective = directive; - } - - // eslint-disable-next-line no-func-assign - nodeLinkFn = compileTemplateUrl(directives.splice(i, directives.length - i), $compileNode, - templateAttrs, jqCollection, hasTranscludeDirective && childTranscludeFn, preLinkFns, postLinkFns, { - controllerDirectives: controllerDirectives, - newScopeDirective: (newScopeDirective !== directive) && newScopeDirective, - newIsolateScopeDirective: newIsolateScopeDirective, - templateDirective: templateDirective, - nonTlbTranscludeDirective: nonTlbTranscludeDirective - }); - ii = directives.length; - } else if (directive.compile) { - try { - linkFn = directive.compile($compileNode, templateAttrs, childTranscludeFn); - var context = directive.$$originalDirective || directive; - if (isFunction(linkFn)) { - addLinkFns(null, bind(context, linkFn), attrStart, attrEnd); - } else if (linkFn) { - addLinkFns(bind(context, linkFn.pre), bind(context, linkFn.post), attrStart, attrEnd); - } - } catch (e) { - $exceptionHandler(e, startingTag($compileNode)); - } - } - - if (directive.terminal) { - nodeLinkFn.terminal = true; - terminalPriority = Math.max(terminalPriority, directive.priority); - } - - } - - nodeLinkFn.scope = newScopeDirective && newScopeDirective.scope === true; - nodeLinkFn.transcludeOnThisElement = hasTranscludeDirective; - nodeLinkFn.templateOnThisElement = hasTemplate; - nodeLinkFn.transclude = childTranscludeFn; - - previousCompileContext.hasElementTranscludeDirective = hasElementTranscludeDirective; - - // might be normal or delayed nodeLinkFn depending on if templateUrl is present - return nodeLinkFn; - - //////////////////// - - function addLinkFns(pre, post, attrStart, attrEnd) { - if (pre) { - if (attrStart) pre = groupElementsLinkFnWrapper(pre, attrStart, attrEnd); - pre.require = directive.require; - pre.directiveName = directiveName; - if (newIsolateScopeDirective === directive || directive.$$isolateScope) { - pre = cloneAndAnnotateFn(pre, {isolateScope: true}); - } - preLinkFns.push(pre); - } - if (post) { - if (attrStart) post = groupElementsLinkFnWrapper(post, attrStart, attrEnd); - post.require = directive.require; - post.directiveName = directiveName; - if (newIsolateScopeDirective === directive || directive.$$isolateScope) { - post = cloneAndAnnotateFn(post, {isolateScope: true}); - } - postLinkFns.push(post); - } - } - - function nodeLinkFn(childLinkFn, scope, linkNode, $rootElement, boundTranscludeFn) { - var i, ii, linkFn, isolateScope, controllerScope, elementControllers, transcludeFn, $element, - attrs, scopeBindingInfo; - - if (compileNode === linkNode) { - attrs = templateAttrs; - $element = templateAttrs.$$element; - } else { - $element = jqLite(linkNode); - attrs = new Attributes($element, templateAttrs); - } - - controllerScope = scope; - if (newIsolateScopeDirective) { - isolateScope = scope.$new(true); - } else if (newScopeDirective) { - controllerScope = scope.$parent; - } - - if (boundTranscludeFn) { - // track `boundTranscludeFn` so it can be unwrapped if `transcludeFn` - // is later passed as `parentBoundTranscludeFn` to `publicLinkFn` - transcludeFn = controllersBoundTransclude; - transcludeFn.$$boundTransclude = boundTranscludeFn; - // expose the slots on the `$transclude` function - transcludeFn.isSlotFilled = function(slotName) { - return !!boundTranscludeFn.$$slots[slotName]; - }; - } - - if (controllerDirectives) { - elementControllers = setupControllers($element, attrs, transcludeFn, controllerDirectives, isolateScope, scope, newIsolateScopeDirective); - } - - if (newIsolateScopeDirective) { - // Initialize isolate scope bindings for new isolate scope directive. - compile.$$addScopeInfo($element, isolateScope, true, !(templateDirective && (templateDirective === newIsolateScopeDirective || - templateDirective === newIsolateScopeDirective.$$originalDirective))); - compile.$$addScopeClass($element, true); - isolateScope.$$isolateBindings = - newIsolateScopeDirective.$$isolateBindings; - scopeBindingInfo = initializeDirectiveBindings(scope, attrs, isolateScope, - isolateScope.$$isolateBindings, - newIsolateScopeDirective); - if (scopeBindingInfo.removeWatches) { - isolateScope.$on('$destroy', scopeBindingInfo.removeWatches); - } - } - - // Initialize bindToController bindings - for (var name in elementControllers) { - var controllerDirective = controllerDirectives[name]; - var controller = elementControllers[name]; - var bindings = controllerDirective.$$bindings.bindToController; - - if (preAssignBindingsEnabled) { - if (bindings) { - controller.bindingInfo = - initializeDirectiveBindings(controllerScope, attrs, controller.instance, bindings, controllerDirective); - } else { - controller.bindingInfo = {}; - } - - var controllerResult = controller(); - if (controllerResult !== controller.instance) { - // If the controller constructor has a return value, overwrite the instance - // from setupControllers - controller.instance = controllerResult; - $element.data('$' + controllerDirective.name + 'Controller', controllerResult); - if (controller.bindingInfo.removeWatches) { - controller.bindingInfo.removeWatches(); - } - controller.bindingInfo = - initializeDirectiveBindings(controllerScope, attrs, controller.instance, bindings, controllerDirective); - } - } else { - controller.instance = controller(); - $element.data('$' + controllerDirective.name + 'Controller', controller.instance); - controller.bindingInfo = - initializeDirectiveBindings(controllerScope, attrs, controller.instance, bindings, controllerDirective); - } - } - - // Bind the required controllers to the controller, if `require` is an object and `bindToController` is truthy - forEach(controllerDirectives, function(controllerDirective, name) { - var require = controllerDirective.require; - if (controllerDirective.bindToController && !isArray(require) && isObject(require)) { - extend(elementControllers[name].instance, getControllers(name, require, $element, elementControllers)); - } - }); - - // Handle the init and destroy lifecycle hooks on all controllers that have them - forEach(elementControllers, function(controller) { - var controllerInstance = controller.instance; - if (isFunction(controllerInstance.$onChanges)) { - try { - controllerInstance.$onChanges(controller.bindingInfo.initialChanges); - } catch (e) { - $exceptionHandler(e); - } - } - if (isFunction(controllerInstance.$onInit)) { - try { - controllerInstance.$onInit(); - } catch (e) { - $exceptionHandler(e); - } - } - if (isFunction(controllerInstance.$doCheck)) { - controllerScope.$watch(function() { controllerInstance.$doCheck(); }); - controllerInstance.$doCheck(); - } - if (isFunction(controllerInstance.$onDestroy)) { - controllerScope.$on('$destroy', function callOnDestroyHook() { - controllerInstance.$onDestroy(); - }); - } - }); - - // PRELINKING - for (i = 0, ii = preLinkFns.length; i < ii; i++) { - linkFn = preLinkFns[i]; - invokeLinkFn(linkFn, - linkFn.isolateScope ? isolateScope : scope, - $element, - attrs, - linkFn.require && getControllers(linkFn.directiveName, linkFn.require, $element, elementControllers), - transcludeFn - ); - } - - // RECURSION - // We only pass the isolate scope, if the isolate directive has a template, - // otherwise the child elements do not belong to the isolate directive. - var scopeToChild = scope; - if (newIsolateScopeDirective && (newIsolateScopeDirective.template || newIsolateScopeDirective.templateUrl === null)) { - scopeToChild = isolateScope; - } - if (childLinkFn) { - childLinkFn(scopeToChild, linkNode.childNodes, undefined, boundTranscludeFn); - } - - // POSTLINKING - for (i = postLinkFns.length - 1; i >= 0; i--) { - linkFn = postLinkFns[i]; - invokeLinkFn(linkFn, - linkFn.isolateScope ? isolateScope : scope, - $element, - attrs, - linkFn.require && getControllers(linkFn.directiveName, linkFn.require, $element, elementControllers), - transcludeFn - ); - } - - // Trigger $postLink lifecycle hooks - forEach(elementControllers, function(controller) { - var controllerInstance = controller.instance; - if (isFunction(controllerInstance.$postLink)) { - controllerInstance.$postLink(); - } - }); - - // This is the function that is injected as `$transclude`. - // Note: all arguments are optional! - function controllersBoundTransclude(scope, cloneAttachFn, futureParentElement, slotName) { - var transcludeControllers; - // No scope passed in: - if (!isScope(scope)) { - slotName = futureParentElement; - futureParentElement = cloneAttachFn; - cloneAttachFn = scope; - scope = undefined; - } - - if (hasElementTranscludeDirective) { - transcludeControllers = elementControllers; - } - if (!futureParentElement) { - futureParentElement = hasElementTranscludeDirective ? $element.parent() : $element; - } - if (slotName) { - // slotTranscludeFn can be one of three things: - // * a transclude function - a filled slot - // * `null` - an optional slot that was not filled - // * `undefined` - a slot that was not declared (i.e. invalid) - var slotTranscludeFn = boundTranscludeFn.$$slots[slotName]; - if (slotTranscludeFn) { - return slotTranscludeFn(scope, cloneAttachFn, transcludeControllers, futureParentElement, scopeToChild); - } else if (isUndefined(slotTranscludeFn)) { - throw $compileMinErr('noslot', - 'No parent directive that requires a transclusion with slot name "{0}". ' + - 'Element: {1}', - slotName, startingTag($element)); - } - } else { - return boundTranscludeFn(scope, cloneAttachFn, transcludeControllers, futureParentElement, scopeToChild); - } - } - } - } - - function getControllers(directiveName, require, $element, elementControllers) { - var value; - - if (isString(require)) { - var match = require.match(REQUIRE_PREFIX_REGEXP); - var name = require.substring(match[0].length); - var inheritType = match[1] || match[3]; - var optional = match[2] === '?'; - - //If only parents then start at the parent element - if (inheritType === '^^') { - $element = $element.parent(); - //Otherwise attempt getting the controller from elementControllers in case - //the element is transcluded (and has no data) and to avoid .data if possible - } else { - value = elementControllers && elementControllers[name]; - value = value && value.instance; - } - - if (!value) { - var dataName = '$' + name + 'Controller'; - value = inheritType ? $element.inheritedData(dataName) : $element.data(dataName); - } - - if (!value && !optional) { - throw $compileMinErr('ctreq', - 'Controller \'{0}\', required by directive \'{1}\', can\'t be found!', - name, directiveName); - } - } else if (isArray(require)) { - value = []; - for (var i = 0, ii = require.length; i < ii; i++) { - value[i] = getControllers(directiveName, require[i], $element, elementControllers); - } - } else if (isObject(require)) { - value = {}; - forEach(require, function(controller, property) { - value[property] = getControllers(directiveName, controller, $element, elementControllers); - }); - } - - return value || null; - } - - function setupControllers($element, attrs, transcludeFn, controllerDirectives, isolateScope, scope, newIsolateScopeDirective) { - var elementControllers = createMap(); - for (var controllerKey in controllerDirectives) { - var directive = controllerDirectives[controllerKey]; - var locals = { - $scope: directive === newIsolateScopeDirective || directive.$$isolateScope ? isolateScope : scope, - $element: $element, - $attrs: attrs, - $transclude: transcludeFn - }; - - var controller = directive.controller; - if (controller === '@') { - controller = attrs[directive.name]; - } - - var controllerInstance = $controller(controller, locals, true, directive.controllerAs); - - // For directives with element transclusion the element is a comment. - // In this case .data will not attach any data. - // Instead, we save the controllers for the element in a local hash and attach to .data - // later, once we have the actual element. - elementControllers[directive.name] = controllerInstance; - $element.data('$' + directive.name + 'Controller', controllerInstance.instance); - } - return elementControllers; - } - - // Depending upon the context in which a directive finds itself it might need to have a new isolated - // or child scope created. For instance: - // * if the directive has been pulled into a template because another directive with a higher priority - // asked for element transclusion - // * if the directive itself asks for transclusion but it is at the root of a template and the original - // element was replaced. See https://github.com/angular/angular.js/issues/12936 - function markDirectiveScope(directives, isolateScope, newScope) { - for (var j = 0, jj = directives.length; j < jj; j++) { - directives[j] = inherit(directives[j], {$$isolateScope: isolateScope, $$newScope: newScope}); - } - } - - /** - * looks up the directive and decorates it with exception handling and proper parameters. We - * call this the boundDirective. - * - * @param {string} name name of the directive to look up. - * @param {string} location The directive must be found in specific format. - * String containing any of theses characters: - * - * * `E`: element name - * * `A': attribute - * * `C`: class - * * `M`: comment - * @returns {boolean} true if directive was added. - */ - function addDirective(tDirectives, name, location, maxPriority, ignoreDirective, startAttrName, - endAttrName) { - if (name === ignoreDirective) return null; - var match = null; - if (hasDirectives.hasOwnProperty(name)) { - for (var directive, directives = $injector.get(name + Suffix), - i = 0, ii = directives.length; i < ii; i++) { - directive = directives[i]; - if ((isUndefined(maxPriority) || maxPriority > directive.priority) && - directive.restrict.indexOf(location) !== -1) { - if (startAttrName) { - directive = inherit(directive, {$$start: startAttrName, $$end: endAttrName}); - } - if (!directive.$$bindings) { - var bindings = directive.$$bindings = - parseDirectiveBindings(directive, directive.name); - if (isObject(bindings.isolateScope)) { - directive.$$isolateBindings = bindings.isolateScope; - } - } - tDirectives.push(directive); - match = directive; - } - } - } - return match; - } - - - /** - * looks up the directive and returns true if it is a multi-element directive, - * and therefore requires DOM nodes between -start and -end markers to be grouped - * together. - * - * @param {string} name name of the directive to look up. - * @returns true if directive was registered as multi-element. - */ - function directiveIsMultiElement(name) { - if (hasDirectives.hasOwnProperty(name)) { - for (var directive, directives = $injector.get(name + Suffix), - i = 0, ii = directives.length; i < ii; i++) { - directive = directives[i]; - if (directive.multiElement) { - return true; - } - } - } - return false; - } - - /** - * When the element is replaced with HTML template then the new attributes - * on the template need to be merged with the existing attributes in the DOM. - * The desired effect is to have both of the attributes present. - * - * @param {object} dst destination attributes (original DOM) - * @param {object} src source attributes (from the directive template) - */ - function mergeTemplateAttributes(dst, src) { - var srcAttr = src.$attr, - dstAttr = dst.$attr; - - // reapply the old attributes to the new element - forEach(dst, function(value, key) { - if (key.charAt(0) !== '$') { - if (src[key] && src[key] !== value) { - if (value.length) { - value += (key === 'style' ? ';' : ' ') + src[key]; - } else { - value = src[key]; - } - } - dst.$set(key, value, true, srcAttr[key]); - } - }); - - // copy the new attributes on the old attrs object - forEach(src, function(value, key) { - // Check if we already set this attribute in the loop above. - // `dst` will never contain hasOwnProperty as DOM parser won't let it. - // You will get an "InvalidCharacterError: DOM Exception 5" error if you - // have an attribute like "has-own-property" or "data-has-own-property", etc. - if (!dst.hasOwnProperty(key) && key.charAt(0) !== '$') { - dst[key] = value; - - if (key !== 'class' && key !== 'style') { - dstAttr[key] = srcAttr[key]; - } - } - }); - } - - - function compileTemplateUrl(directives, $compileNode, tAttrs, - $rootElement, childTranscludeFn, preLinkFns, postLinkFns, previousCompileContext) { - var linkQueue = [], - afterTemplateNodeLinkFn, - afterTemplateChildLinkFn, - beforeTemplateCompileNode = $compileNode[0], - origAsyncDirective = directives.shift(), - derivedSyncDirective = inherit(origAsyncDirective, { - templateUrl: null, transclude: null, replace: null, $$originalDirective: origAsyncDirective - }), - templateUrl = (isFunction(origAsyncDirective.templateUrl)) - ? origAsyncDirective.templateUrl($compileNode, tAttrs) - : origAsyncDirective.templateUrl, - templateNamespace = origAsyncDirective.templateNamespace; - - $compileNode.empty(); - - $templateRequest(templateUrl) - .then(function(content) { - var compileNode, tempTemplateAttrs, $template, childBoundTranscludeFn; - - content = denormalizeTemplate(content); - - if (origAsyncDirective.replace) { - if (jqLiteIsTextNode(content)) { - $template = []; - } else { - $template = removeComments(wrapTemplate(templateNamespace, trim(content))); - } - compileNode = $template[0]; - - if ($template.length !== 1 || compileNode.nodeType !== NODE_TYPE_ELEMENT) { - throw $compileMinErr('tplrt', - 'Template for directive \'{0}\' must have exactly one root element. {1}', - origAsyncDirective.name, templateUrl); - } - - tempTemplateAttrs = {$attr: {}}; - replaceWith($rootElement, $compileNode, compileNode); - var templateDirectives = collectDirectives(compileNode, [], tempTemplateAttrs); - - if (isObject(origAsyncDirective.scope)) { - // the original directive that caused the template to be loaded async required - // an isolate scope - markDirectiveScope(templateDirectives, true); - } - directives = templateDirectives.concat(directives); - mergeTemplateAttributes(tAttrs, tempTemplateAttrs); - } else { - compileNode = beforeTemplateCompileNode; - $compileNode.html(content); - } - - directives.unshift(derivedSyncDirective); - - afterTemplateNodeLinkFn = applyDirectivesToNode(directives, compileNode, tAttrs, - childTranscludeFn, $compileNode, origAsyncDirective, preLinkFns, postLinkFns, - previousCompileContext); - forEach($rootElement, function(node, i) { - if (node === compileNode) { - $rootElement[i] = $compileNode[0]; - } - }); - afterTemplateChildLinkFn = compileNodes($compileNode[0].childNodes, childTranscludeFn); - - while (linkQueue.length) { - var scope = linkQueue.shift(), - beforeTemplateLinkNode = linkQueue.shift(), - linkRootElement = linkQueue.shift(), - boundTranscludeFn = linkQueue.shift(), - linkNode = $compileNode[0]; - - if (scope.$$destroyed) continue; - - if (beforeTemplateLinkNode !== beforeTemplateCompileNode) { - var oldClasses = beforeTemplateLinkNode.className; - - if (!(previousCompileContext.hasElementTranscludeDirective && - origAsyncDirective.replace)) { - // it was cloned therefore we have to clone as well. - linkNode = jqLiteClone(compileNode); - } - replaceWith(linkRootElement, jqLite(beforeTemplateLinkNode), linkNode); - - // Copy in CSS classes from original node - safeAddClass(jqLite(linkNode), oldClasses); - } - if (afterTemplateNodeLinkFn.transcludeOnThisElement) { - childBoundTranscludeFn = createBoundTranscludeFn(scope, afterTemplateNodeLinkFn.transclude, boundTranscludeFn); - } else { - childBoundTranscludeFn = boundTranscludeFn; - } - afterTemplateNodeLinkFn(afterTemplateChildLinkFn, scope, linkNode, $rootElement, - childBoundTranscludeFn); - } - linkQueue = null; - }).catch(function(error) { - if (error instanceof Error) { - $exceptionHandler(error); - } - }).catch(noop); - - return function delayedNodeLinkFn(ignoreChildLinkFn, scope, node, rootElement, boundTranscludeFn) { - var childBoundTranscludeFn = boundTranscludeFn; - if (scope.$$destroyed) return; - if (linkQueue) { - linkQueue.push(scope, - node, - rootElement, - childBoundTranscludeFn); - } else { - if (afterTemplateNodeLinkFn.transcludeOnThisElement) { - childBoundTranscludeFn = createBoundTranscludeFn(scope, afterTemplateNodeLinkFn.transclude, boundTranscludeFn); - } - afterTemplateNodeLinkFn(afterTemplateChildLinkFn, scope, node, rootElement, childBoundTranscludeFn); - } - }; - } - - - /** - * Sorting function for bound directives. - */ - function byPriority(a, b) { - var diff = b.priority - a.priority; - if (diff !== 0) return diff; - if (a.name !== b.name) return (a.name < b.name) ? -1 : 1; - return a.index - b.index; - } - - function assertNoDuplicate(what, previousDirective, directive, element) { - - function wrapModuleNameIfDefined(moduleName) { - return moduleName ? - (' (module: ' + moduleName + ')') : - ''; - } - - if (previousDirective) { - throw $compileMinErr('multidir', 'Multiple directives [{0}{1}, {2}{3}] asking for {4} on: {5}', - previousDirective.name, wrapModuleNameIfDefined(previousDirective.$$moduleName), - directive.name, wrapModuleNameIfDefined(directive.$$moduleName), what, startingTag(element)); - } - } - - - function addTextInterpolateDirective(directives, text) { - var interpolateFn = $interpolate(text, true); - if (interpolateFn) { - directives.push({ - priority: 0, - compile: function textInterpolateCompileFn(templateNode) { - var templateNodeParent = templateNode.parent(), - hasCompileParent = !!templateNodeParent.length; - - // When transcluding a template that has bindings in the root - // we don't have a parent and thus need to add the class during linking fn. - if (hasCompileParent) compile.$$addBindingClass(templateNodeParent); - - return function textInterpolateLinkFn(scope, node) { - var parent = node.parent(); - if (!hasCompileParent) compile.$$addBindingClass(parent); - compile.$$addBindingInfo(parent, interpolateFn.expressions); - scope.$watch(interpolateFn, function interpolateFnWatchAction(value) { - node[0].nodeValue = value; - }); - }; - } - }); - } - } - - - function wrapTemplate(type, template) { - type = lowercase(type || 'html'); - switch (type) { - case 'svg': - case 'math': - var wrapper = window.document.createElement('div'); - wrapper.innerHTML = '<' + type + '>' + template + ''; - return wrapper.childNodes[0].childNodes; - default: - return template; - } - } - - - function getTrustedContext(node, attrNormalizedName) { - if (attrNormalizedName === 'srcdoc') { - return $sce.HTML; - } - var tag = nodeName_(node); - // All tags with src attributes require a RESOURCE_URL value, except for - // img and various html5 media tags. - if (attrNormalizedName === 'src' || attrNormalizedName === 'ngSrc') { - if (['img', 'video', 'audio', 'source', 'track'].indexOf(tag) === -1) { - return $sce.RESOURCE_URL; - } - // maction[xlink:href] can source SVG. It's not limited to . - } else if (attrNormalizedName === 'xlinkHref' || - (tag === 'form' && attrNormalizedName === 'action') || - // links can be stylesheets or imports, which can run script in the current origin - (tag === 'link' && attrNormalizedName === 'href') - ) { - return $sce.RESOURCE_URL; - } - } - - - function addAttrInterpolateDirective(node, directives, value, name, isNgAttr) { - var trustedContext = getTrustedContext(node, name); - var mustHaveExpression = !isNgAttr; - var allOrNothing = ALL_OR_NOTHING_ATTRS[name] || isNgAttr; - - var interpolateFn = $interpolate(value, mustHaveExpression, trustedContext, allOrNothing); - - // no interpolation found -> ignore - if (!interpolateFn) return; - - if (name === 'multiple' && nodeName_(node) === 'select') { - throw $compileMinErr('selmulti', - 'Binding to the \'multiple\' attribute is not supported. Element: {0}', - startingTag(node)); - } - - if (EVENT_HANDLER_ATTR_REGEXP.test(name)) { - throw $compileMinErr('nodomevents', - 'Interpolations for HTML DOM event attributes are disallowed. Please use the ' + - 'ng- versions (such as ng-click instead of onclick) instead.'); - } - - directives.push({ - priority: 100, - compile: function() { - return { - pre: function attrInterpolatePreLinkFn(scope, element, attr) { - var $$observers = (attr.$$observers || (attr.$$observers = createMap())); - - // If the attribute has changed since last $interpolate()ed - var newValue = attr[name]; - if (newValue !== value) { - // we need to interpolate again since the attribute value has been updated - // (e.g. by another directive's compile function) - // ensure unset/empty values make interpolateFn falsy - interpolateFn = newValue && $interpolate(newValue, true, trustedContext, allOrNothing); - value = newValue; - } - - // if attribute was updated so that there is no interpolation going on we don't want to - // register any observers - if (!interpolateFn) return; - - // initialize attr object so that it's ready in case we need the value for isolate - // scope initialization, otherwise the value would not be available from isolate - // directive's linking fn during linking phase - attr[name] = interpolateFn(scope); - - ($$observers[name] || ($$observers[name] = [])).$$inter = true; - (attr.$$observers && attr.$$observers[name].$$scope || scope). - $watch(interpolateFn, function interpolateFnWatchAction(newValue, oldValue) { - //special case for class attribute addition + removal - //so that class changes can tap into the animation - //hooks provided by the $animate service. Be sure to - //skip animations when the first digest occurs (when - //both the new and the old values are the same) since - //the CSS classes are the non-interpolated values - if (name === 'class' && newValue !== oldValue) { - attr.$updateClass(newValue, oldValue); - } else { - attr.$set(name, newValue); - } - }); - } - }; - } - }); - } - - - /** - * This is a special jqLite.replaceWith, which can replace items which - * have no parents, provided that the containing jqLite collection is provided. - * - * @param {JqLite=} $rootElement The root of the compile tree. Used so that we can replace nodes - * in the root of the tree. - * @param {JqLite} elementsToRemove The jqLite element which we are going to replace. We keep - * the shell, but replace its DOM node reference. - * @param {Node} newNode The new DOM node. - */ - function replaceWith($rootElement, elementsToRemove, newNode) { - var firstElementToRemove = elementsToRemove[0], - removeCount = elementsToRemove.length, - parent = firstElementToRemove.parentNode, - i, ii; - - if ($rootElement) { - for (i = 0, ii = $rootElement.length; i < ii; i++) { - if ($rootElement[i] === firstElementToRemove) { - $rootElement[i++] = newNode; - for (var j = i, j2 = j + removeCount - 1, - jj = $rootElement.length; - j < jj; j++, j2++) { - if (j2 < jj) { - $rootElement[j] = $rootElement[j2]; - } else { - delete $rootElement[j]; - } - } - $rootElement.length -= removeCount - 1; - - // If the replaced element is also the jQuery .context then replace it - // .context is a deprecated jQuery api, so we should set it only when jQuery set it - // http://api.jquery.com/context/ - if ($rootElement.context === firstElementToRemove) { - $rootElement.context = newNode; - } - break; - } - } - } - - if (parent) { - parent.replaceChild(newNode, firstElementToRemove); - } - - // Append all the `elementsToRemove` to a fragment. This will... - // - remove them from the DOM - // - allow them to still be traversed with .nextSibling - // - allow a single fragment.qSA to fetch all elements being removed - var fragment = window.document.createDocumentFragment(); - for (i = 0; i < removeCount; i++) { - fragment.appendChild(elementsToRemove[i]); - } - - if (jqLite.hasData(firstElementToRemove)) { - // Copy over user data (that includes Angular's $scope etc.). Don't copy private - // data here because there's no public interface in jQuery to do that and copying over - // event listeners (which is the main use of private data) wouldn't work anyway. - jqLite.data(newNode, jqLite.data(firstElementToRemove)); - - // Remove $destroy event listeners from `firstElementToRemove` - jqLite(firstElementToRemove).off('$destroy'); - } - - // Cleanup any data/listeners on the elements and children. - // This includes invoking the $destroy event on any elements with listeners. - jqLite.cleanData(fragment.querySelectorAll('*')); - - // Update the jqLite collection to only contain the `newNode` - for (i = 1; i < removeCount; i++) { - delete elementsToRemove[i]; - } - elementsToRemove[0] = newNode; - elementsToRemove.length = 1; - } - - - function cloneAndAnnotateFn(fn, annotation) { - return extend(function() { return fn.apply(null, arguments); }, fn, annotation); - } - - - function invokeLinkFn(linkFn, scope, $element, attrs, controllers, transcludeFn) { - try { - linkFn(scope, $element, attrs, controllers, transcludeFn); - } catch (e) { - $exceptionHandler(e, startingTag($element)); - } - } - - - // Set up $watches for isolate scope and controller bindings. - function initializeDirectiveBindings(scope, attrs, destination, bindings, directive) { - var removeWatchCollection = []; - var initialChanges = {}; - var changes; - forEach(bindings, function initializeBinding(definition, scopeName) { - var attrName = definition.attrName, - optional = definition.optional, - mode = definition.mode, // @, =, <, or & - lastValue, - parentGet, parentSet, compare, removeWatch; - - switch (mode) { - - case '@': - if (!optional && !hasOwnProperty.call(attrs, attrName)) { - destination[scopeName] = attrs[attrName] = undefined; - } - removeWatch = attrs.$observe(attrName, function(value) { - if (isString(value) || isBoolean(value)) { - var oldValue = destination[scopeName]; - recordChanges(scopeName, value, oldValue); - destination[scopeName] = value; - } - }); - attrs.$$observers[attrName].$$scope = scope; - lastValue = attrs[attrName]; - if (isString(lastValue)) { - // If the attribute has been provided then we trigger an interpolation to ensure - // the value is there for use in the link fn - destination[scopeName] = $interpolate(lastValue)(scope); - } else if (isBoolean(lastValue)) { - // If the attributes is one of the BOOLEAN_ATTR then Angular will have converted - // the value to boolean rather than a string, so we special case this situation - destination[scopeName] = lastValue; - } - initialChanges[scopeName] = new SimpleChange(_UNINITIALIZED_VALUE, destination[scopeName]); - removeWatchCollection.push(removeWatch); - break; - - case '=': - if (!hasOwnProperty.call(attrs, attrName)) { - if (optional) break; - attrs[attrName] = undefined; - } - if (optional && !attrs[attrName]) break; - - parentGet = $parse(attrs[attrName]); - if (parentGet.literal) { - compare = equals; - } else { - // eslint-disable-next-line no-self-compare - compare = function simpleCompare(a, b) { return a === b || (a !== a && b !== b); }; - } - parentSet = parentGet.assign || function() { - // reset the change, or we will throw this exception on every $digest - lastValue = destination[scopeName] = parentGet(scope); - throw $compileMinErr('nonassign', - 'Expression \'{0}\' in attribute \'{1}\' used with directive \'{2}\' is non-assignable!', - attrs[attrName], attrName, directive.name); - }; - lastValue = destination[scopeName] = parentGet(scope); - var parentValueWatch = function parentValueWatch(parentValue) { - if (!compare(parentValue, destination[scopeName])) { - // we are out of sync and need to copy - if (!compare(parentValue, lastValue)) { - // parent changed and it has precedence - destination[scopeName] = parentValue; - } else { - // if the parent can be assigned then do so - parentSet(scope, parentValue = destination[scopeName]); - } - } - lastValue = parentValue; - return lastValue; - }; - parentValueWatch.$stateful = true; - if (definition.collection) { - removeWatch = scope.$watchCollection(attrs[attrName], parentValueWatch); - } else { - removeWatch = scope.$watch($parse(attrs[attrName], parentValueWatch), null, parentGet.literal); - } - removeWatchCollection.push(removeWatch); - break; - - case '<': - if (!hasOwnProperty.call(attrs, attrName)) { - if (optional) break; - attrs[attrName] = undefined; - } - if (optional && !attrs[attrName]) break; - - parentGet = $parse(attrs[attrName]); - var deepWatch = parentGet.literal; - - var initialValue = destination[scopeName] = parentGet(scope); - initialChanges[scopeName] = new SimpleChange(_UNINITIALIZED_VALUE, destination[scopeName]); - - removeWatch = scope.$watch(parentGet, function parentValueWatchAction(newValue, oldValue) { - if (oldValue === newValue) { - if (oldValue === initialValue || (deepWatch && equals(oldValue, initialValue))) { - return; - } - oldValue = initialValue; - } - recordChanges(scopeName, newValue, oldValue); - destination[scopeName] = newValue; - }, deepWatch); - - removeWatchCollection.push(removeWatch); - break; - - case '&': - // Don't assign Object.prototype method to scope - parentGet = attrs.hasOwnProperty(attrName) ? $parse(attrs[attrName]) : noop; - - // Don't assign noop to destination if expression is not valid - if (parentGet === noop && optional) break; - - destination[scopeName] = function(locals) { - return parentGet(scope, locals); - }; - break; - } - }); - - function recordChanges(key, currentValue, previousValue) { - if (isFunction(destination.$onChanges) && currentValue !== previousValue && - // eslint-disable-next-line no-self-compare - (currentValue === currentValue || previousValue === previousValue)) { - // If we have not already scheduled the top level onChangesQueue handler then do so now - if (!onChangesQueue) { - scope.$$postDigest(flushOnChangesQueue); - onChangesQueue = []; - } - // If we have not already queued a trigger of onChanges for this controller then do so now - if (!changes) { - changes = {}; - onChangesQueue.push(triggerOnChangesHook); - } - // If the has been a change on this property already then we need to reuse the previous value - if (changes[key]) { - previousValue = changes[key].previousValue; - } - // Store this change - changes[key] = new SimpleChange(previousValue, currentValue); - } - } - - function triggerOnChangesHook() { - destination.$onChanges(changes); - // Now clear the changes so that we schedule onChanges when more changes arrive - changes = undefined; - } - - return { - initialChanges: initialChanges, - removeWatches: removeWatchCollection.length && function removeWatches() { - for (var i = 0, ii = removeWatchCollection.length; i < ii; ++i) { - removeWatchCollection[i](); - } - } - }; - } - }]; -} - -function SimpleChange(previous, current) { - this.previousValue = previous; - this.currentValue = current; -} -SimpleChange.prototype.isFirstChange = function() { return this.previousValue === _UNINITIALIZED_VALUE; }; - - -var PREFIX_REGEXP = /^((?:x|data)[:\-_])/i; -var SPECIAL_CHARS_REGEXP = /[:\-_]+(.)/g; - -/** - * Converts all accepted directives format into proper directive name. - * @param name Name to normalize - */ -function directiveNormalize(name) { - return name - .replace(PREFIX_REGEXP, '') - .replace(SPECIAL_CHARS_REGEXP, fnCamelCaseReplace); -} - -/** - * @ngdoc type - * @name $compile.directive.Attributes - * - * @description - * A shared object between directive compile / linking functions which contains normalized DOM - * element attributes. The values reflect current binding state `{{ }}`. The normalization is - * needed since all of these are treated as equivalent in Angular: - * - * ``` - * - * ``` - */ - -/** - * @ngdoc property - * @name $compile.directive.Attributes#$attr - * - * @description - * A map of DOM element attribute names to the normalized name. This is - * needed to do reverse lookup from normalized name back to actual name. - */ - - -/** - * @ngdoc method - * @name $compile.directive.Attributes#$set - * @kind function - * - * @description - * Set DOM element attribute value. - * - * - * @param {string} name Normalized element attribute name of the property to modify. The name is - * reverse-translated using the {@link ng.$compile.directive.Attributes#$attr $attr} - * property to the original name. - * @param {string} value Value to set the attribute to. The value can be an interpolated string. - */ - - - -/** - * Closure compiler type information - */ - -function nodesetLinkingFn( - /* angular.Scope */ scope, - /* NodeList */ nodeList, - /* Element */ rootElement, - /* function(Function) */ boundTranscludeFn -) {} - -function directiveLinkingFn( - /* nodesetLinkingFn */ nodesetLinkingFn, - /* angular.Scope */ scope, - /* Node */ node, - /* Element */ rootElement, - /* function(Function) */ boundTranscludeFn -) {} - -function tokenDifference(str1, str2) { - var values = '', - tokens1 = str1.split(/\s+/), - tokens2 = str2.split(/\s+/); - - outer: - for (var i = 0; i < tokens1.length; i++) { - var token = tokens1[i]; - for (var j = 0; j < tokens2.length; j++) { - if (token === tokens2[j]) continue outer; - } - values += (values.length > 0 ? ' ' : '') + token; - } - return values; -} - -function removeComments(jqNodes) { - jqNodes = jqLite(jqNodes); - var i = jqNodes.length; - - if (i <= 1) { - return jqNodes; - } - - while (i--) { - var node = jqNodes[i]; - if (node.nodeType === NODE_TYPE_COMMENT || - (node.nodeType === NODE_TYPE_TEXT && node.nodeValue.trim() === '')) { - splice.call(jqNodes, i, 1); - } - } - return jqNodes; -} - -var $controllerMinErr = minErr('$controller'); - - -var CNTRL_REG = /^(\S+)(\s+as\s+([\w$]+))?$/; -function identifierForController(controller, ident) { - if (ident && isString(ident)) return ident; - if (isString(controller)) { - var match = CNTRL_REG.exec(controller); - if (match) return match[3]; - } -} - - -/** - * @ngdoc provider - * @name $controllerProvider - * @this - * - * @description - * The {@link ng.$controller $controller service} is used by Angular to create new - * controllers. - * - * This provider allows controller registration via the - * {@link ng.$controllerProvider#register register} method. - */ -function $ControllerProvider() { - var controllers = {}, - globals = false; - - /** - * @ngdoc method - * @name $controllerProvider#has - * @param {string} name Controller name to check. - */ - this.has = function(name) { - return controllers.hasOwnProperty(name); - }; - - /** - * @ngdoc method - * @name $controllerProvider#register - * @param {string|Object} name Controller name, or an object map of controllers where the keys are - * the names and the values are the constructors. - * @param {Function|Array} constructor Controller constructor fn (optionally decorated with DI - * annotations in the array notation). - */ - this.register = function(name, constructor) { - assertNotHasOwnProperty(name, 'controller'); - if (isObject(name)) { - extend(controllers, name); - } else { - controllers[name] = constructor; - } - }; - - /** - * @ngdoc method - * @name $controllerProvider#allowGlobals - * @description If called, allows `$controller` to find controller constructors on `window` - * - * @deprecated - * sinceVersion="v1.3.0" - * removeVersion="v1.7.0" - * This method of finding controllers has been deprecated. - */ - this.allowGlobals = function() { - globals = true; - }; - - - this.$get = ['$injector', '$window', function($injector, $window) { - - /** - * @ngdoc service - * @name $controller - * @requires $injector - * - * @param {Function|string} constructor If called with a function then it's considered to be the - * controller constructor function. Otherwise it's considered to be a string which is used - * to retrieve the controller constructor using the following steps: - * - * * check if a controller with given name is registered via `$controllerProvider` - * * check if evaluating the string on the current scope returns a constructor - * * if $controllerProvider#allowGlobals, check `window[constructor]` on the global - * `window` object (deprecated, not recommended) - * - * The string can use the `controller as property` syntax, where the controller instance is published - * as the specified property on the `scope`; the `scope` must be injected into `locals` param for this - * to work correctly. - * - * @param {Object} locals Injection locals for Controller. - * @return {Object} Instance of given controller. - * - * @description - * `$controller` service is responsible for instantiating controllers. - * - * It's just a simple call to {@link auto.$injector $injector}, but extracted into - * a service, so that one can override this service with [BC version](https://gist.github.com/1649788). - */ - return function $controller(expression, locals, later, ident) { - // PRIVATE API: - // param `later` --- indicates that the controller's constructor is invoked at a later time. - // If true, $controller will allocate the object with the correct - // prototype chain, but will not invoke the controller until a returned - // callback is invoked. - // param `ident` --- An optional label which overrides the label parsed from the controller - // expression, if any. - var instance, match, constructor, identifier; - later = later === true; - if (ident && isString(ident)) { - identifier = ident; - } - - if (isString(expression)) { - match = expression.match(CNTRL_REG); - if (!match) { - throw $controllerMinErr('ctrlfmt', - 'Badly formed controller string \'{0}\'. ' + - 'Must match `__name__ as __id__` or `__name__`.', expression); - } - constructor = match[1]; - identifier = identifier || match[3]; - expression = controllers.hasOwnProperty(constructor) - ? controllers[constructor] - : getter(locals.$scope, constructor, true) || - (globals ? getter($window, constructor, true) : undefined); - - if (!expression) { - throw $controllerMinErr('ctrlreg', - 'The controller with the name \'{0}\' is not registered.', constructor); - } - - assertArgFn(expression, constructor, true); - } - - if (later) { - // Instantiate controller later: - // This machinery is used to create an instance of the object before calling the - // controller's constructor itself. - // - // This allows properties to be added to the controller before the constructor is - // invoked. Primarily, this is used for isolate scope bindings in $compile. - // - // This feature is not intended for use by applications, and is thus not documented - // publicly. - // Object creation: http://jsperf.com/create-constructor/2 - var controllerPrototype = (isArray(expression) ? - expression[expression.length - 1] : expression).prototype; - instance = Object.create(controllerPrototype || null); - - if (identifier) { - addIdentifier(locals, identifier, instance, constructor || expression.name); - } - - return extend(function $controllerInit() { - var result = $injector.invoke(expression, instance, locals, constructor); - if (result !== instance && (isObject(result) || isFunction(result))) { - instance = result; - if (identifier) { - // If result changed, re-assign controllerAs value to scope. - addIdentifier(locals, identifier, instance, constructor || expression.name); - } - } - return instance; - }, { - instance: instance, - identifier: identifier - }); - } - - instance = $injector.instantiate(expression, locals, constructor); - - if (identifier) { - addIdentifier(locals, identifier, instance, constructor || expression.name); - } - - return instance; - }; - - function addIdentifier(locals, identifier, instance, name) { - if (!(locals && isObject(locals.$scope))) { - throw minErr('$controller')('noscp', - 'Cannot export controller \'{0}\' as \'{1}\'! No $scope object provided via `locals`.', - name, identifier); - } - - locals.$scope[identifier] = instance; - } - }]; -} - -/** - * @ngdoc service - * @name $document - * @requires $window - * @this - * - * @description - * A {@link angular.element jQuery or jqLite} wrapper for the browser's `window.document` object. - * - * @example - - -
-

$document title:

-

window.document title:

-
- - - angular.module('documentExample', []) - .controller('ExampleController', ['$scope', '$document', function($scope, $document) { - $scope.title = $document[0].title; - $scope.windowTitle = angular.element(window.document)[0].title; - }]); - - - */ -function $DocumentProvider() { - this.$get = ['$window', function(window) { - return jqLite(window.document); - }]; -} - - -/** - * @private - * @this - * Listens for document visibility change and makes the current status accessible. - */ -function $$IsDocumentHiddenProvider() { - this.$get = ['$document', '$rootScope', function($document, $rootScope) { - var doc = $document[0]; - var hidden = doc && doc.hidden; - - $document.on('visibilitychange', changeListener); - - $rootScope.$on('$destroy', function() { - $document.off('visibilitychange', changeListener); - }); - - function changeListener() { - hidden = doc.hidden; - } - - return function() { - return hidden; - }; - }]; -} - -/** - * @ngdoc service - * @name $exceptionHandler - * @requires ng.$log - * @this - * - * @description - * Any uncaught exception in angular expressions is delegated to this service. - * The default implementation simply delegates to `$log.error` which logs it into - * the browser console. - * - * In unit tests, if `angular-mocks.js` is loaded, this service is overridden by - * {@link ngMock.$exceptionHandler mock $exceptionHandler} which aids in testing. - * - * ## Example: - * - * The example below will overwrite the default `$exceptionHandler` in order to (a) log uncaught - * errors to the backend for later inspection by the developers and (b) to use `$log.warn()` instead - * of `$log.error()`. - * - * ```js - * angular. - * module('exceptionOverwrite', []). - * factory('$exceptionHandler', ['$log', 'logErrorsToBackend', function($log, logErrorsToBackend) { - * return function myExceptionHandler(exception, cause) { - * logErrorsToBackend(exception, cause); - * $log.warn(exception, cause); - * }; - * }]); - * ``` - * - *
- * Note, that code executed in event-listeners (even those registered using jqLite's `on`/`bind` - * methods) does not delegate exceptions to the {@link ng.$exceptionHandler $exceptionHandler} - * (unless executed during a digest). - * - * If you wish, you can manually delegate exceptions, e.g. - * `try { ... } catch(e) { $exceptionHandler(e); }` - * - * @param {Error} exception Exception associated with the error. - * @param {string=} cause Optional information about the context in which - * the error was thrown. - * - */ -function $ExceptionHandlerProvider() { - this.$get = ['$log', function($log) { - return function(exception, cause) { - $log.error.apply($log, arguments); - }; - }]; -} - -var $$ForceReflowProvider = /** @this */ function() { - this.$get = ['$document', function($document) { - return function(domNode) { - //the line below will force the browser to perform a repaint so - //that all the animated elements within the animation frame will - //be properly updated and drawn on screen. This is required to - //ensure that the preparation animation is properly flushed so that - //the active state picks up from there. DO NOT REMOVE THIS LINE. - //DO NOT OPTIMIZE THIS LINE. THE MINIFIER WILL REMOVE IT OTHERWISE WHICH - //WILL RESULT IN AN UNPREDICTABLE BUG THAT IS VERY HARD TO TRACK DOWN AND - //WILL TAKE YEARS AWAY FROM YOUR LIFE. - if (domNode) { - if (!domNode.nodeType && domNode instanceof jqLite) { - domNode = domNode[0]; - } - } else { - domNode = $document[0].body; - } - return domNode.offsetWidth + 1; - }; - }]; -}; - -var APPLICATION_JSON = 'application/json'; -var CONTENT_TYPE_APPLICATION_JSON = {'Content-Type': APPLICATION_JSON + ';charset=utf-8'}; -var JSON_START = /^\[|^\{(?!\{)/; -var JSON_ENDS = { - '[': /]$/, - '{': /}$/ -}; -var JSON_PROTECTION_PREFIX = /^\)]\}',?\n/; -var $httpMinErr = minErr('$http'); - -function serializeValue(v) { - if (isObject(v)) { - return isDate(v) ? v.toISOString() : toJson(v); - } - return v; -} - - -/** @this */ -function $HttpParamSerializerProvider() { - /** - * @ngdoc service - * @name $httpParamSerializer - * @description - * - * Default {@link $http `$http`} params serializer that converts objects to strings - * according to the following rules: - * - * * `{'foo': 'bar'}` results in `foo=bar` - * * `{'foo': Date.now()}` results in `foo=2015-04-01T09%3A50%3A49.262Z` (`toISOString()` and encoded representation of a Date object) - * * `{'foo': ['bar', 'baz']}` results in `foo=bar&foo=baz` (repeated key for each array element) - * * `{'foo': {'bar':'baz'}}` results in `foo=%7B%22bar%22%3A%22baz%22%7D` (stringified and encoded representation of an object) - * - * Note that serializer will sort the request parameters alphabetically. - * */ - - this.$get = function() { - return function ngParamSerializer(params) { - if (!params) return ''; - var parts = []; - forEachSorted(params, function(value, key) { - if (value === null || isUndefined(value)) return; - if (isArray(value)) { - forEach(value, function(v) { - parts.push(encodeUriQuery(key) + '=' + encodeUriQuery(serializeValue(v))); - }); - } else { - parts.push(encodeUriQuery(key) + '=' + encodeUriQuery(serializeValue(value))); - } - }); - - return parts.join('&'); - }; - }; -} - -/** @this */ -function $HttpParamSerializerJQLikeProvider() { - /** - * @ngdoc service - * @name $httpParamSerializerJQLike - * - * @description - * - * Alternative {@link $http `$http`} params serializer that follows - * jQuery's [`param()`](http://api.jquery.com/jquery.param/) method logic. - * The serializer will also sort the params alphabetically. - * - * To use it for serializing `$http` request parameters, set it as the `paramSerializer` property: - * - * ```js - * $http({ - * url: myUrl, - * method: 'GET', - * params: myParams, - * paramSerializer: '$httpParamSerializerJQLike' - * }); - * ``` - * - * It is also possible to set it as the default `paramSerializer` in the - * {@link $httpProvider#defaults `$httpProvider`}. - * - * Additionally, you can inject the serializer and use it explicitly, for example to serialize - * form data for submission: - * - * ```js - * .controller(function($http, $httpParamSerializerJQLike) { - * //... - * - * $http({ - * url: myUrl, - * method: 'POST', - * data: $httpParamSerializerJQLike(myData), - * headers: { - * 'Content-Type': 'application/x-www-form-urlencoded' - * } - * }); - * - * }); - * ``` - * - * */ - this.$get = function() { - return function jQueryLikeParamSerializer(params) { - if (!params) return ''; - var parts = []; - serialize(params, '', true); - return parts.join('&'); - - function serialize(toSerialize, prefix, topLevel) { - if (toSerialize === null || isUndefined(toSerialize)) return; - if (isArray(toSerialize)) { - forEach(toSerialize, function(value, index) { - serialize(value, prefix + '[' + (isObject(value) ? index : '') + ']'); - }); - } else if (isObject(toSerialize) && !isDate(toSerialize)) { - forEachSorted(toSerialize, function(value, key) { - serialize(value, prefix + - (topLevel ? '' : '[') + - key + - (topLevel ? '' : ']')); - }); - } else { - parts.push(encodeUriQuery(prefix) + '=' + encodeUriQuery(serializeValue(toSerialize))); - } - } - }; - }; -} - -function defaultHttpResponseTransform(data, headers) { - if (isString(data)) { - // Strip json vulnerability protection prefix and trim whitespace - var tempData = data.replace(JSON_PROTECTION_PREFIX, '').trim(); - - if (tempData) { - var contentType = headers('Content-Type'); - if ((contentType && (contentType.indexOf(APPLICATION_JSON) === 0)) || isJsonLike(tempData)) { - data = fromJson(tempData); - } - } - } - - return data; -} - -function isJsonLike(str) { - var jsonStart = str.match(JSON_START); - return jsonStart && JSON_ENDS[jsonStart[0]].test(str); -} - -/** - * Parse headers into key value object - * - * @param {string} headers Raw headers as a string - * @returns {Object} Parsed headers as key value object - */ -function parseHeaders(headers) { - var parsed = createMap(), i; - - function fillInParsed(key, val) { - if (key) { - parsed[key] = parsed[key] ? parsed[key] + ', ' + val : val; - } - } - - if (isString(headers)) { - forEach(headers.split('\n'), function(line) { - i = line.indexOf(':'); - fillInParsed(lowercase(trim(line.substr(0, i))), trim(line.substr(i + 1))); - }); - } else if (isObject(headers)) { - forEach(headers, function(headerVal, headerKey) { - fillInParsed(lowercase(headerKey), trim(headerVal)); - }); - } - - return parsed; -} - - -/** - * Returns a function that provides access to parsed headers. - * - * Headers are lazy parsed when first requested. - * @see parseHeaders - * - * @param {(string|Object)} headers Headers to provide access to. - * @returns {function(string=)} Returns a getter function which if called with: - * - * - if called with an argument returns a single header value or null - * - if called with no arguments returns an object containing all headers. - */ -function headersGetter(headers) { - var headersObj; - - return function(name) { - if (!headersObj) headersObj = parseHeaders(headers); - - if (name) { - var value = headersObj[lowercase(name)]; - if (value === undefined) { - value = null; - } - return value; - } - - return headersObj; - }; -} - - -/** - * Chain all given functions - * - * This function is used for both request and response transforming - * - * @param {*} data Data to transform. - * @param {function(string=)} headers HTTP headers getter fn. - * @param {number} status HTTP status code of the response. - * @param {(Function|Array.)} fns Function or an array of functions. - * @returns {*} Transformed data. - */ -function transformData(data, headers, status, fns) { - if (isFunction(fns)) { - return fns(data, headers, status); - } - - forEach(fns, function(fn) { - data = fn(data, headers, status); - }); - - return data; -} - - -function isSuccess(status) { - return 200 <= status && status < 300; -} - - -/** - * @ngdoc provider - * @name $httpProvider - * @this - * - * @description - * Use `$httpProvider` to change the default behavior of the {@link ng.$http $http} service. - * */ -function $HttpProvider() { - /** - * @ngdoc property - * @name $httpProvider#defaults - * @description - * - * Object containing default values for all {@link ng.$http $http} requests. - * - * - **`defaults.cache`** - {boolean|Object} - A boolean value or object created with - * {@link ng.$cacheFactory `$cacheFactory`} to enable or disable caching of HTTP responses - * by default. See {@link $http#caching $http Caching} for more information. - * - * - **`defaults.xsrfCookieName`** - {string} - Name of cookie containing the XSRF token. - * Defaults value is `'XSRF-TOKEN'`. - * - * - **`defaults.xsrfHeaderName`** - {string} - Name of HTTP header to populate with the - * XSRF token. Defaults value is `'X-XSRF-TOKEN'`. - * - * - **`defaults.headers`** - {Object} - Default headers for all $http requests. - * Refer to {@link ng.$http#setting-http-headers $http} for documentation on - * setting default headers. - * - **`defaults.headers.common`** - * - **`defaults.headers.post`** - * - **`defaults.headers.put`** - * - **`defaults.headers.patch`** - * - * - * - **`defaults.paramSerializer`** - `{string|function(Object):string}` - A function - * used to the prepare string representation of request parameters (specified as an object). - * If specified as string, it is interpreted as a function registered with the {@link auto.$injector $injector}. - * Defaults to {@link ng.$httpParamSerializer $httpParamSerializer}. - * - * - **`defaults.jsonpCallbackParam`** - `{string}` - the name of the query parameter that passes the name of the - * callback in a JSONP request. The value of this parameter will be replaced with the expression generated by the - * {@link $jsonpCallbacks} service. Defaults to `'callback'`. - * - **/ - var defaults = this.defaults = { - // transform incoming response data - transformResponse: [defaultHttpResponseTransform], - - // transform outgoing request data - transformRequest: [function(d) { - return isObject(d) && !isFile(d) && !isBlob(d) && !isFormData(d) ? toJson(d) : d; - }], - - // default headers - headers: { - common: { - 'Accept': 'application/json, text/plain, */*' - }, - post: shallowCopy(CONTENT_TYPE_APPLICATION_JSON), - put: shallowCopy(CONTENT_TYPE_APPLICATION_JSON), - patch: shallowCopy(CONTENT_TYPE_APPLICATION_JSON) - }, - - xsrfCookieName: 'XSRF-TOKEN', - xsrfHeaderName: 'X-XSRF-TOKEN', - - paramSerializer: '$httpParamSerializer', - - jsonpCallbackParam: 'callback' - }; - - var useApplyAsync = false; - /** - * @ngdoc method - * @name $httpProvider#useApplyAsync - * @description - * - * Configure $http service to combine processing of multiple http responses received at around - * the same time via {@link ng.$rootScope.Scope#$applyAsync $rootScope.$applyAsync}. This can result in - * significant performance improvement for bigger applications that make many HTTP requests - * concurrently (common during application bootstrap). - * - * Defaults to false. If no value is specified, returns the current configured value. - * - * @param {boolean=} value If true, when requests are loaded, they will schedule a deferred - * "apply" on the next tick, giving time for subsequent requests in a roughly ~10ms window - * to load and share the same digest cycle. - * - * @returns {boolean|Object} If a value is specified, returns the $httpProvider for chaining. - * otherwise, returns the current configured value. - **/ - this.useApplyAsync = function(value) { - if (isDefined(value)) { - useApplyAsync = !!value; - return this; - } - return useApplyAsync; - }; - - /** - * @ngdoc property - * @name $httpProvider#interceptors - * @description - * - * Array containing service factories for all synchronous or asynchronous {@link ng.$http $http} - * pre-processing of request or postprocessing of responses. - * - * These service factories are ordered by request, i.e. they are applied in the same order as the - * array, on request, but reverse order, on response. - * - * {@link ng.$http#interceptors Interceptors detailed info} - **/ - var interceptorFactories = this.interceptors = []; - - this.$get = ['$browser', '$httpBackend', '$$cookieReader', '$cacheFactory', '$rootScope', '$q', '$injector', '$sce', - function($browser, $httpBackend, $$cookieReader, $cacheFactory, $rootScope, $q, $injector, $sce) { - - var defaultCache = $cacheFactory('$http'); - - /** - * Make sure that default param serializer is exposed as a function - */ - defaults.paramSerializer = isString(defaults.paramSerializer) ? - $injector.get(defaults.paramSerializer) : defaults.paramSerializer; - - /** - * Interceptors stored in reverse order. Inner interceptors before outer interceptors. - * The reversal is needed so that we can build up the interception chain around the - * server request. - */ - var reversedInterceptors = []; - - forEach(interceptorFactories, function(interceptorFactory) { - reversedInterceptors.unshift(isString(interceptorFactory) - ? $injector.get(interceptorFactory) : $injector.invoke(interceptorFactory)); - }); - - /** - * @ngdoc service - * @kind function - * @name $http - * @requires ng.$httpBackend - * @requires $cacheFactory - * @requires $rootScope - * @requires $q - * @requires $injector - * - * @description - * The `$http` service is a core Angular service that facilitates communication with the remote - * HTTP servers via the browser's [XMLHttpRequest](https://developer.mozilla.org/en/xmlhttprequest) - * object or via [JSONP](http://en.wikipedia.org/wiki/JSONP). - * - * For unit testing applications that use `$http` service, see - * {@link ngMock.$httpBackend $httpBackend mock}. - * - * For a higher level of abstraction, please check out the {@link ngResource.$resource - * $resource} service. - * - * The $http API is based on the {@link ng.$q deferred/promise APIs} exposed by - * the $q service. While for simple usage patterns this doesn't matter much, for advanced usage - * it is important to familiarize yourself with these APIs and the guarantees they provide. - * - * - * ## General usage - * The `$http` service is a function which takes a single argument — a {@link $http#usage configuration object} — - * that is used to generate an HTTP request and returns a {@link ng.$q promise}. - * - * ```js - * // Simple GET request example: - * $http({ - * method: 'GET', - * url: '/someUrl' - * }).then(function successCallback(response) { - * // this callback will be called asynchronously - * // when the response is available - * }, function errorCallback(response) { - * // called asynchronously if an error occurs - * // or server returns response with an error status. - * }); - * ``` - * - * The response object has these properties: - * - * - **data** – `{string|Object}` – The response body transformed with the transform - * functions. - * - **status** – `{number}` – HTTP status code of the response. - * - **headers** – `{function([headerName])}` – Header getter function. - * - **config** – `{Object}` – The configuration object that was used to generate the request. - * - **statusText** – `{string}` – HTTP status text of the response. - * - * A response status code between 200 and 299 is considered a success status and will result in - * the success callback being called. Any response status code outside of that range is - * considered an error status and will result in the error callback being called. - * Also, status codes less than -1 are normalized to zero. -1 usually means the request was - * aborted, e.g. using a `config.timeout`. - * Note that if the response is a redirect, XMLHttpRequest will transparently follow it, meaning - * that the outcome (success or error) will be determined by the final response status code. - * - * - * ## Shortcut methods - * - * Shortcut methods are also available. All shortcut methods require passing in the URL, and - * request data must be passed in for POST/PUT requests. An optional config can be passed as the - * last argument. - * - * ```js - * $http.get('/someUrl', config).then(successCallback, errorCallback); - * $http.post('/someUrl', data, config).then(successCallback, errorCallback); - * ``` - * - * Complete list of shortcut methods: - * - * - {@link ng.$http#get $http.get} - * - {@link ng.$http#head $http.head} - * - {@link ng.$http#post $http.post} - * - {@link ng.$http#put $http.put} - * - {@link ng.$http#delete $http.delete} - * - {@link ng.$http#jsonp $http.jsonp} - * - {@link ng.$http#patch $http.patch} - * - * - * ## Writing Unit Tests that use $http - * When unit testing (using {@link ngMock ngMock}), it is necessary to call - * {@link ngMock.$httpBackend#flush $httpBackend.flush()} to flush each pending - * request using trained responses. - * - * ``` - * $httpBackend.expectGET(...); - * $http.get(...); - * $httpBackend.flush(); - * ``` - * - * ## Setting HTTP Headers - * - * The $http service will automatically add certain HTTP headers to all requests. These defaults - * can be fully configured by accessing the `$httpProvider.defaults.headers` configuration - * object, which currently contains this default configuration: - * - * - `$httpProvider.defaults.headers.common` (headers that are common for all requests): - * - Accept: application/json, text/plain, \*/\* - * - `$httpProvider.defaults.headers.post`: (header defaults for POST requests) - * - `Content-Type: application/json` - * - `$httpProvider.defaults.headers.put` (header defaults for PUT requests) - * - `Content-Type: application/json` - * - * To add or overwrite these defaults, simply add or remove a property from these configuration - * objects. To add headers for an HTTP method other than POST or PUT, simply add a new object - * with the lowercased HTTP method name as the key, e.g. - * `$httpProvider.defaults.headers.get = { 'My-Header' : 'value' }`. - * - * The defaults can also be set at runtime via the `$http.defaults` object in the same - * fashion. For example: - * - * ``` - * module.run(function($http) { - * $http.defaults.headers.common.Authorization = 'Basic YmVlcDpib29w'; - * }); - * ``` - * - * In addition, you can supply a `headers` property in the config object passed when - * calling `$http(config)`, which overrides the defaults without changing them globally. - * - * To explicitly remove a header automatically added via $httpProvider.defaults.headers on a per request basis, - * Use the `headers` property, setting the desired header to `undefined`. For example: - * - * ```js - * var req = { - * method: 'POST', - * url: 'http://example.com', - * headers: { - * 'Content-Type': undefined - * }, - * data: { test: 'test' } - * } - * - * $http(req).then(function(){...}, function(){...}); - * ``` - * - * ## Transforming Requests and Responses - * - * Both requests and responses can be transformed using transformation functions: `transformRequest` - * and `transformResponse`. These properties can be a single function that returns - * the transformed value (`function(data, headersGetter, status)`) or an array of such transformation functions, - * which allows you to `push` or `unshift` a new transformation function into the transformation chain. - * - *
- * **Note:** Angular does not make a copy of the `data` parameter before it is passed into the `transformRequest` pipeline. - * That means changes to the properties of `data` are not local to the transform function (since Javascript passes objects by reference). - * For example, when calling `$http.get(url, $scope.myObject)`, modifications to the object's properties in a transformRequest - * function will be reflected on the scope and in any templates where the object is data-bound. - * To prevent this, transform functions should have no side-effects. - * If you need to modify properties, it is recommended to make a copy of the data, or create new object to return. - *
- * - * ### Default Transformations - * - * The `$httpProvider` provider and `$http` service expose `defaults.transformRequest` and - * `defaults.transformResponse` properties. If a request does not provide its own transformations - * then these will be applied. - * - * You can augment or replace the default transformations by modifying these properties by adding to or - * replacing the array. - * - * Angular provides the following default transformations: - * - * Request transformations (`$httpProvider.defaults.transformRequest` and `$http.defaults.transformRequest`): - * - * - If the `data` property of the request configuration object contains an object, serialize it - * into JSON format. - * - * Response transformations (`$httpProvider.defaults.transformResponse` and `$http.defaults.transformResponse`): - * - * - If XSRF prefix is detected, strip it (see Security Considerations section below). - * - If JSON response is detected, deserialize it using a JSON parser. - * - * - * ### Overriding the Default Transformations Per Request - * - * If you wish to override the request/response transformations only for a single request then provide - * `transformRequest` and/or `transformResponse` properties on the configuration object passed - * into `$http`. - * - * Note that if you provide these properties on the config object the default transformations will be - * overwritten. If you wish to augment the default transformations then you must include them in your - * local transformation array. - * - * The following code demonstrates adding a new response transformation to be run after the default response - * transformations have been run. - * - * ```js - * function appendTransform(defaults, transform) { - * - * // We can't guarantee that the default transformation is an array - * defaults = angular.isArray(defaults) ? defaults : [defaults]; - * - * // Append the new transformation to the defaults - * return defaults.concat(transform); - * } - * - * $http({ - * url: '...', - * method: 'GET', - * transformResponse: appendTransform($http.defaults.transformResponse, function(value) { - * return doTransform(value); - * }) - * }); - * ``` - * - * - * ## Caching - * - * {@link ng.$http `$http`} responses are not cached by default. To enable caching, you must - * set the config.cache value or the default cache value to TRUE or to a cache object (created - * with {@link ng.$cacheFactory `$cacheFactory`}). If defined, the value of config.cache takes - * precedence over the default cache value. - * - * In order to: - * * cache all responses - set the default cache value to TRUE or to a cache object - * * cache a specific response - set config.cache value to TRUE or to a cache object - * - * If caching is enabled, but neither the default cache nor config.cache are set to a cache object, - * then the default `$cacheFactory("$http")` object is used. - * - * The default cache value can be set by updating the - * {@link ng.$http#defaults `$http.defaults.cache`} property or the - * {@link $httpProvider#defaults `$httpProvider.defaults.cache`} property. - * - * When caching is enabled, {@link ng.$http `$http`} stores the response from the server using - * the relevant cache object. The next time the same request is made, the response is returned - * from the cache without sending a request to the server. - * - * Take note that: - * - * * Only GET and JSONP requests are cached. - * * The cache key is the request URL including search parameters; headers are not considered. - * * Cached responses are returned asynchronously, in the same way as responses from the server. - * * If multiple identical requests are made using the same cache, which is not yet populated, - * one request will be made to the server and remaining requests will return the same response. - * * A cache-control header on the response does not affect if or how responses are cached. - * - * - * ## Interceptors - * - * Before you start creating interceptors, be sure to understand the - * {@link ng.$q $q and deferred/promise APIs}. - * - * For purposes of global error handling, authentication, or any kind of synchronous or - * asynchronous pre-processing of request or postprocessing of responses, it is desirable to be - * able to intercept requests before they are handed to the server and - * responses before they are handed over to the application code that - * initiated these requests. The interceptors leverage the {@link ng.$q - * promise APIs} to fulfill this need for both synchronous and asynchronous pre-processing. - * - * The interceptors are service factories that are registered with the `$httpProvider` by - * adding them to the `$httpProvider.interceptors` array. The factory is called and - * injected with dependencies (if specified) and returns the interceptor. - * - * There are two kinds of interceptors (and two kinds of rejection interceptors): - * - * * `request`: interceptors get called with a http {@link $http#usage config} object. The function is free to - * modify the `config` object or create a new one. The function needs to return the `config` - * object directly, or a promise containing the `config` or a new `config` object. - * * `requestError`: interceptor gets called when a previous interceptor threw an error or - * resolved with a rejection. - * * `response`: interceptors get called with http `response` object. The function is free to - * modify the `response` object or create a new one. The function needs to return the `response` - * object directly, or as a promise containing the `response` or a new `response` object. - * * `responseError`: interceptor gets called when a previous interceptor threw an error or - * resolved with a rejection. - * - * - * ```js - * // register the interceptor as a service - * $provide.factory('myHttpInterceptor', function($q, dependency1, dependency2) { - * return { - * // optional method - * 'request': function(config) { - * // do something on success - * return config; - * }, - * - * // optional method - * 'requestError': function(rejection) { - * // do something on error - * if (canRecover(rejection)) { - * return responseOrNewPromise - * } - * return $q.reject(rejection); - * }, - * - * - * - * // optional method - * 'response': function(response) { - * // do something on success - * return response; - * }, - * - * // optional method - * 'responseError': function(rejection) { - * // do something on error - * if (canRecover(rejection)) { - * return responseOrNewPromise - * } - * return $q.reject(rejection); - * } - * }; - * }); - * - * $httpProvider.interceptors.push('myHttpInterceptor'); - * - * - * // alternatively, register the interceptor via an anonymous factory - * $httpProvider.interceptors.push(function($q, dependency1, dependency2) { - * return { - * 'request': function(config) { - * // same as above - * }, - * - * 'response': function(response) { - * // same as above - * } - * }; - * }); - * ``` - * - * ## Security Considerations - * - * When designing web applications, consider security threats from: - * - * - [JSON vulnerability](http://haacked.com/archive/2008/11/20/anatomy-of-a-subtle-json-vulnerability.aspx) - * - [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) - * - * Both server and the client must cooperate in order to eliminate these threats. Angular comes - * pre-configured with strategies that address these issues, but for this to work backend server - * cooperation is required. - * - * ### JSON Vulnerability Protection - * - * A [JSON vulnerability](http://haacked.com/archive/2008/11/20/anatomy-of-a-subtle-json-vulnerability.aspx) - * allows third party website to turn your JSON resource URL into - * [JSONP](http://en.wikipedia.org/wiki/JSONP) request under some conditions. To - * counter this your server can prefix all JSON requests with following string `")]}',\n"`. - * Angular will automatically strip the prefix before processing it as JSON. - * - * For example if your server needs to return: - * ```js - * ['one','two'] - * ``` - * - * which is vulnerable to attack, your server can return: - * ```js - * )]}', - * ['one','two'] - * ``` - * - * Angular will strip the prefix, before processing the JSON. - * - * - * ### Cross Site Request Forgery (XSRF) Protection - * - * [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) is an attack technique by - * which the attacker can trick an authenticated user into unknowingly executing actions on your - * website. Angular provides a mechanism to counter XSRF. When performing XHR requests, the - * $http service reads a token from a cookie (by default, `XSRF-TOKEN`) and sets it as an HTTP - * header (`X-XSRF-TOKEN`). Since only JavaScript that runs on your domain could read the - * cookie, your server can be assured that the XHR came from JavaScript running on your domain. - * The header will not be set for cross-domain requests. - * - * To take advantage of this, your server needs to set a token in a JavaScript readable session - * cookie called `XSRF-TOKEN` on the first HTTP GET request. On subsequent XHR requests the - * server can verify that the cookie matches `X-XSRF-TOKEN` HTTP header, and therefore be sure - * that only JavaScript running on your domain could have sent the request. The token must be - * unique for each user and must be verifiable by the server (to prevent the JavaScript from - * making up its own tokens). We recommend that the token is a digest of your site's - * authentication cookie with a [salt](https://en.wikipedia.org/wiki/Salt_(cryptography)) - * for added security. - * - * The name of the headers can be specified using the xsrfHeaderName and xsrfCookieName - * properties of either $httpProvider.defaults at config-time, $http.defaults at run-time, - * or the per-request config object. - * - * In order to prevent collisions in environments where multiple Angular apps share the - * same domain or subdomain, we recommend that each application uses unique cookie name. - * - * @param {object} config Object describing the request to be made and how it should be - * processed. The object has following properties: - * - * - **method** – `{string}` – HTTP method (e.g. 'GET', 'POST', etc) - * - **url** – `{string|TrustedObject}` – Absolute or relative URL of the resource that is being requested; - * or an object created by a call to `$sce.trustAsResourceUrl(url)`. - * - **params** – `{Object.}` – Map of strings or objects which will be serialized - * with the `paramSerializer` and appended as GET parameters. - * - **data** – `{string|Object}` – Data to be sent as the request message data. - * - **headers** – `{Object}` – Map of strings or functions which return strings representing - * HTTP headers to send to the server. If the return value of a function is null, the - * header will not be sent. Functions accept a config object as an argument. - * - **eventHandlers** - `{Object}` - Event listeners to be bound to the XMLHttpRequest object. - * To bind events to the XMLHttpRequest upload object, use `uploadEventHandlers`. - * The handler will be called in the context of a `$apply` block. - * - **uploadEventHandlers** - `{Object}` - Event listeners to be bound to the XMLHttpRequest upload - * object. To bind events to the XMLHttpRequest object, use `eventHandlers`. - * The handler will be called in the context of a `$apply` block. - * - **xsrfHeaderName** – `{string}` – Name of HTTP header to populate with the XSRF token. - * - **xsrfCookieName** – `{string}` – Name of cookie containing the XSRF token. - * - **transformRequest** – - * `{function(data, headersGetter)|Array.}` – - * transform function or an array of such functions. The transform function takes the http - * request body and headers and returns its transformed (typically serialized) version. - * See {@link ng.$http#overriding-the-default-transformations-per-request - * Overriding the Default Transformations} - * - **transformResponse** – - * `{function(data, headersGetter, status)|Array.}` – - * transform function or an array of such functions. The transform function takes the http - * response body, headers and status and returns its transformed (typically deserialized) version. - * See {@link ng.$http#overriding-the-default-transformations-per-request - * Overriding the Default Transformations} - * - **paramSerializer** - `{string|function(Object):string}` - A function used to - * prepare the string representation of request parameters (specified as an object). - * If specified as string, it is interpreted as function registered with the - * {@link $injector $injector}, which means you can create your own serializer - * by registering it as a {@link auto.$provide#service service}. - * The default serializer is the {@link $httpParamSerializer $httpParamSerializer}; - * alternatively, you can use the {@link $httpParamSerializerJQLike $httpParamSerializerJQLike} - * - **cache** – `{boolean|Object}` – A boolean value or object created with - * {@link ng.$cacheFactory `$cacheFactory`} to enable or disable caching of the HTTP response. - * See {@link $http#caching $http Caching} for more information. - * - **timeout** – `{number|Promise}` – timeout in milliseconds, or {@link ng.$q promise} - * that should abort the request when resolved. - * - **withCredentials** - `{boolean}` - whether to set the `withCredentials` flag on the - * XHR object. See [requests with credentials](https://developer.mozilla.org/docs/Web/HTTP/Access_control_CORS#Requests_with_credentials) - * for more information. - * - **responseType** - `{string}` - see - * [XMLHttpRequest.responseType](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest#xmlhttprequest-responsetype). - * - * @returns {HttpPromise} Returns a {@link ng.$q `Promise}` that will be resolved to a response object - * when the request succeeds or fails. - * - * - * @property {Array.} pendingRequests Array of config objects for currently pending - * requests. This is primarily meant to be used for debugging purposes. - * - * - * @example - - -
- - -
- - - - 
http status code: {{status}}
- 
http response data: {{data}}
-
- - - angular.module('httpExample', []) - .config(['$sceDelegateProvider', function($sceDelegateProvider) { - // We must whitelist the JSONP endpoint that we are using to show that we trust it - $sceDelegateProvider.resourceUrlWhitelist([ - 'self', - 'https://angularjs.org/**' - ]); - }]) - .controller('FetchController', ['$scope', '$http', '$templateCache', - function($scope, $http, $templateCache) { - $scope.method = 'GET'; - $scope.url = 'http-hello.html'; - - $scope.fetch = function() { - $scope.code = null; - $scope.response = null; - - $http({method: $scope.method, url: $scope.url, cache: $templateCache}). - then(function(response) { - $scope.status = response.status; - $scope.data = response.data; - }, function(response) { - $scope.data = response.data || 'Request failed'; - $scope.status = response.status; - }); - }; - - $scope.updateModel = function(method, url) { - $scope.method = method; - $scope.url = url; - }; - }]); - - - Hello, $http! - - - var status = element(by.binding('status')); - var data = element(by.binding('data')); - var fetchBtn = element(by.id('fetchbtn')); - var sampleGetBtn = element(by.id('samplegetbtn')); - var invalidJsonpBtn = element(by.id('invalidjsonpbtn')); - - it('should make an xhr GET request', function() { - sampleGetBtn.click(); - fetchBtn.click(); - expect(status.getText()).toMatch('200'); - expect(data.getText()).toMatch(/Hello, \$http!/); - }); - -// Commented out due to flakes. See https://github.com/angular/angular.js/issues/9185 -// it('should make a JSONP request to angularjs.org', function() { -// var sampleJsonpBtn = element(by.id('samplejsonpbtn')); -// sampleJsonpBtn.click(); -// fetchBtn.click(); -// expect(status.getText()).toMatch('200'); -// expect(data.getText()).toMatch(/Super Hero!/); -// }); - - it('should make JSONP request to invalid URL and invoke the error handler', - function() { - invalidJsonpBtn.click(); - fetchBtn.click(); - expect(status.getText()).toMatch('0'); - expect(data.getText()).toMatch('Request failed'); - }); - - - */ - function $http(requestConfig) { - - if (!isObject(requestConfig)) { - throw minErr('$http')('badreq', 'Http request configuration must be an object. Received: {0}', requestConfig); - } - - if (!isString($sce.valueOf(requestConfig.url))) { - throw minErr('$http')('badreq', 'Http request configuration url must be a string or a $sce trusted object. Received: {0}', requestConfig.url); - } - - var config = extend({ - method: 'get', - transformRequest: defaults.transformRequest, - transformResponse: defaults.transformResponse, - paramSerializer: defaults.paramSerializer, - jsonpCallbackParam: defaults.jsonpCallbackParam - }, requestConfig); - - config.headers = mergeHeaders(requestConfig); - config.method = uppercase(config.method); - config.paramSerializer = isString(config.paramSerializer) ? - $injector.get(config.paramSerializer) : config.paramSerializer; - - $browser.$$incOutstandingRequestCount(); - - var requestInterceptors = []; - var responseInterceptors = []; - var promise = $q.resolve(config); - - // apply interceptors - forEach(reversedInterceptors, function(interceptor) { - if (interceptor.request || interceptor.requestError) { - requestInterceptors.unshift(interceptor.request, interceptor.requestError); - } - if (interceptor.response || interceptor.responseError) { - responseInterceptors.push(interceptor.response, interceptor.responseError); - } - }); - - promise = chainInterceptors(promise, requestInterceptors); - promise = promise.then(serverRequest); - promise = chainInterceptors(promise, responseInterceptors); - promise = promise.finally(completeOutstandingRequest); - - return promise; - - - function chainInterceptors(promise, interceptors) { - for (var i = 0, ii = interceptors.length; i < ii;) { - var thenFn = interceptors[i++]; - var rejectFn = interceptors[i++]; - - promise = promise.then(thenFn, rejectFn); - } - - interceptors.length = 0; - - return promise; - } - - function completeOutstandingRequest() { - $browser.$$completeOutstandingRequest(noop); - } - - function executeHeaderFns(headers, config) { - var headerContent, processedHeaders = {}; - - forEach(headers, function(headerFn, header) { - if (isFunction(headerFn)) { - headerContent = headerFn(config); - if (headerContent != null) { - processedHeaders[header] = headerContent; - } - } else { - processedHeaders[header] = headerFn; - } - }); - - return processedHeaders; - } - - function mergeHeaders(config) { - var defHeaders = defaults.headers, - reqHeaders = extend({}, config.headers), - defHeaderName, lowercaseDefHeaderName, reqHeaderName; - - defHeaders = extend({}, defHeaders.common, defHeaders[lowercase(config.method)]); - - // using for-in instead of forEach to avoid unnecessary iteration after header has been found - defaultHeadersIteration: - for (defHeaderName in defHeaders) { - lowercaseDefHeaderName = lowercase(defHeaderName); - - for (reqHeaderName in reqHeaders) { - if (lowercase(reqHeaderName) === lowercaseDefHeaderName) { - continue defaultHeadersIteration; - } - } - - reqHeaders[defHeaderName] = defHeaders[defHeaderName]; - } - - // execute if header value is a function for merged headers - return executeHeaderFns(reqHeaders, shallowCopy(config)); - } - - function serverRequest(config) { - var headers = config.headers; - var reqData = transformData(config.data, headersGetter(headers), undefined, config.transformRequest); - - // strip content-type if data is undefined - if (isUndefined(reqData)) { - forEach(headers, function(value, header) { - if (lowercase(header) === 'content-type') { - delete headers[header]; - } - }); - } - - if (isUndefined(config.withCredentials) && !isUndefined(defaults.withCredentials)) { - config.withCredentials = defaults.withCredentials; - } - - // send request - return sendReq(config, reqData).then(transformResponse, transformResponse); - } - - function transformResponse(response) { - // make a copy since the response must be cacheable - var resp = extend({}, response); - resp.data = transformData(response.data, response.headers, response.status, - config.transformResponse); - return (isSuccess(response.status)) - ? resp - : $q.reject(resp); - } - } - - $http.pendingRequests = []; - - /** - * @ngdoc method - * @name $http#get - * - * @description - * Shortcut method to perform `GET` request. - * - * @param {string|TrustedObject} url Absolute or relative URL of the resource that is being requested; - * or an object created by a call to `$sce.trustAsResourceUrl(url)`. - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#delete - * - * @description - * Shortcut method to perform `DELETE` request. - * - * @param {string|TrustedObject} url Absolute or relative URL of the resource that is being requested; - * or an object created by a call to `$sce.trustAsResourceUrl(url)`. - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#head - * - * @description - * Shortcut method to perform `HEAD` request. - * - * @param {string|TrustedObject} url Absolute or relative URL of the resource that is being requested; - * or an object created by a call to `$sce.trustAsResourceUrl(url)`. - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#jsonp - * - * @description - * Shortcut method to perform `JSONP` request. - * - * Note that, since JSONP requests are sensitive because the response is given full access to the browser, - * the url must be declared, via {@link $sce} as a trusted resource URL. - * You can trust a URL by adding it to the whitelist via - * {@link $sceDelegateProvider#resourceUrlWhitelist `$sceDelegateProvider.resourceUrlWhitelist`} or - * by explicitly trusting the URL via {@link $sce#trustAsResourceUrl `$sce.trustAsResourceUrl(url)`}. - * - * JSONP requests must specify a callback to be used in the response from the server. This callback - * is passed as a query parameter in the request. You must specify the name of this parameter by - * setting the `jsonpCallbackParam` property on the request config object. - * - * ``` - * $http.jsonp('some/trusted/url', {jsonpCallbackParam: 'callback'}) - * ``` - * - * You can also specify a default callback parameter name in `$http.defaults.jsonpCallbackParam`. - * Initially this is set to `'callback'`. - * - *
- * You can no longer use the `JSON_CALLBACK` string as a placeholder for specifying where the callback - * parameter value should go. - *
- * - * If you would like to customise where and how the callbacks are stored then try overriding - * or decorating the {@link $jsonpCallbacks} service. - * - * @param {string|TrustedObject} url Absolute or relative URL of the resource that is being requested; - * or an object created by a call to `$sce.trustAsResourceUrl(url)`. - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - createShortMethods('get', 'delete', 'head', 'jsonp'); - - /** - * @ngdoc method - * @name $http#post - * - * @description - * Shortcut method to perform `POST` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {*} data Request content - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#put - * - * @description - * Shortcut method to perform `PUT` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {*} data Request content - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#patch - * - * @description - * Shortcut method to perform `PATCH` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {*} data Request content - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - createShortMethodsWithData('post', 'put', 'patch'); - - /** - * @ngdoc property - * @name $http#defaults - * - * @description - * Runtime equivalent of the `$httpProvider.defaults` property. Allows configuration of - * default headers, withCredentials as well as request and response transformations. - * - * See "Setting HTTP Headers" and "Transforming Requests and Responses" sections above. - */ - $http.defaults = defaults; - - - return $http; - - - function createShortMethods(names) { - forEach(arguments, function(name) { - $http[name] = function(url, config) { - return $http(extend({}, config || {}, { - method: name, - url: url - })); - }; - }); - } - - - function createShortMethodsWithData(name) { - forEach(arguments, function(name) { - $http[name] = function(url, data, config) { - return $http(extend({}, config || {}, { - method: name, - url: url, - data: data - })); - }; - }); - } - - - /** - * Makes the request. - * - * !!! ACCESSES CLOSURE VARS: - * $httpBackend, defaults, $log, $rootScope, defaultCache, $http.pendingRequests - */ - function sendReq(config, reqData) { - var deferred = $q.defer(), - promise = deferred.promise, - cache, - cachedResp, - reqHeaders = config.headers, - isJsonp = lowercase(config.method) === 'jsonp', - url = config.url; - - if (isJsonp) { - // JSONP is a pretty sensitive operation where we're allowing a script to have full access to - // our DOM and JS space. So we require that the URL satisfies SCE.RESOURCE_URL. - url = $sce.getTrustedResourceUrl(url); - } else if (!isString(url)) { - // If it is not a string then the URL must be a $sce trusted object - url = $sce.valueOf(url); - } - - url = buildUrl(url, config.paramSerializer(config.params)); - - if (isJsonp) { - // Check the url and add the JSONP callback placeholder - url = sanitizeJsonpCallbackParam(url, config.jsonpCallbackParam); - } - - $http.pendingRequests.push(config); - promise.then(removePendingReq, removePendingReq); - - if ((config.cache || defaults.cache) && config.cache !== false && - (config.method === 'GET' || config.method === 'JSONP')) { - cache = isObject(config.cache) ? config.cache - : isObject(defaults.cache) ? defaults.cache - : defaultCache; - } - - if (cache) { - cachedResp = cache.get(url); - if (isDefined(cachedResp)) { - if (isPromiseLike(cachedResp)) { - // cached request has already been sent, but there is no response yet - cachedResp.then(resolvePromiseWithResult, resolvePromiseWithResult); - } else { - // serving from cache - if (isArray(cachedResp)) { - resolvePromise(cachedResp[1], cachedResp[0], shallowCopy(cachedResp[2]), cachedResp[3]); - } else { - resolvePromise(cachedResp, 200, {}, 'OK'); - } - } - } else { - // put the promise for the non-transformed response into cache as a placeholder - cache.put(url, promise); - } - } - - - // if we won't have the response in cache, set the xsrf headers and - // send the request to the backend - if (isUndefined(cachedResp)) { - var xsrfValue = urlIsSameOrigin(config.url) - ? $$cookieReader()[config.xsrfCookieName || defaults.xsrfCookieName] - : undefined; - if (xsrfValue) { - reqHeaders[(config.xsrfHeaderName || defaults.xsrfHeaderName)] = xsrfValue; - } - - $httpBackend(config.method, url, reqData, done, reqHeaders, config.timeout, - config.withCredentials, config.responseType, - createApplyHandlers(config.eventHandlers), - createApplyHandlers(config.uploadEventHandlers)); - } - - return promise; - - function createApplyHandlers(eventHandlers) { - if (eventHandlers) { - var applyHandlers = {}; - forEach(eventHandlers, function(eventHandler, key) { - applyHandlers[key] = function(event) { - if (useApplyAsync) { - $rootScope.$applyAsync(callEventHandler); - } else if ($rootScope.$$phase) { - callEventHandler(); - } else { - $rootScope.$apply(callEventHandler); - } - - function callEventHandler() { - eventHandler(event); - } - }; - }); - return applyHandlers; - } - } - - - /** - * Callback registered to $httpBackend(): - * - caches the response if desired - * - resolves the raw $http promise - * - calls $apply - */ - function done(status, response, headersString, statusText) { - if (cache) { - if (isSuccess(status)) { - cache.put(url, [status, response, parseHeaders(headersString), statusText]); - } else { - // remove promise from the cache - cache.remove(url); - } - } - - function resolveHttpPromise() { - resolvePromise(response, status, headersString, statusText); - } - - if (useApplyAsync) { - $rootScope.$applyAsync(resolveHttpPromise); - } else { - resolveHttpPromise(); - if (!$rootScope.$$phase) $rootScope.$apply(); - } - } - - - /** - * Resolves the raw $http promise. - */ - function resolvePromise(response, status, headers, statusText) { - //status: HTTP response status code, 0, -1 (aborted by timeout / promise) - status = status >= -1 ? status : 0; - - (isSuccess(status) ? deferred.resolve : deferred.reject)({ - data: response, - status: status, - headers: headersGetter(headers), - config: config, - statusText: statusText - }); - } - - function resolvePromiseWithResult(result) { - resolvePromise(result.data, result.status, shallowCopy(result.headers()), result.statusText); - } - - function removePendingReq() { - var idx = $http.pendingRequests.indexOf(config); - if (idx !== -1) $http.pendingRequests.splice(idx, 1); - } - } - - - function buildUrl(url, serializedParams) { - if (serializedParams.length > 0) { - url += ((url.indexOf('?') === -1) ? '?' : '&') + serializedParams; - } - return url; - } - - function sanitizeJsonpCallbackParam(url, key) { - if (/[&?][^=]+=JSON_CALLBACK/.test(url)) { - // Throw if the url already contains a reference to JSON_CALLBACK - throw $httpMinErr('badjsonp', 'Illegal use of JSON_CALLBACK in url, "{0}"', url); - } - - var callbackParamRegex = new RegExp('[&?]' + key + '='); - if (callbackParamRegex.test(url)) { - // Throw if the callback param was already provided - throw $httpMinErr('badjsonp', 'Illegal use of callback param, "{0}", in url, "{1}"', key, url); - } - - // Add in the JSON_CALLBACK callback param value - url += ((url.indexOf('?') === -1) ? '?' : '&') + key + '=JSON_CALLBACK'; - - return url; - } - }]; -} - -/** - * @ngdoc service - * @name $xhrFactory - * @this - * - * @description - * Factory function used to create XMLHttpRequest objects. - * - * Replace or decorate this service to create your own custom XMLHttpRequest objects. - * - * ``` - * angular.module('myApp', []) - * .factory('$xhrFactory', function() { - * return function createXhr(method, url) { - * return new window.XMLHttpRequest({mozSystem: true}); - * }; - * }); - * ``` - * - * @param {string} method HTTP method of the request (GET, POST, PUT, ..) - * @param {string} url URL of the request. - */ -function $xhrFactoryProvider() { - this.$get = function() { - return function createXhr() { - return new window.XMLHttpRequest(); - }; - }; -} - -/** - * @ngdoc service - * @name $httpBackend - * @requires $jsonpCallbacks - * @requires $document - * @requires $xhrFactory - * @this - * - * @description - * HTTP backend used by the {@link ng.$http service} that delegates to - * XMLHttpRequest object or JSONP and deals with browser incompatibilities. - * - * You should never need to use this service directly, instead use the higher-level abstractions: - * {@link ng.$http $http} or {@link ngResource.$resource $resource}. - * - * During testing this implementation is swapped with {@link ngMock.$httpBackend mock - * $httpBackend} which can be trained with responses. - */ -function $HttpBackendProvider() { - this.$get = ['$browser', '$jsonpCallbacks', '$document', '$xhrFactory', function($browser, $jsonpCallbacks, $document, $xhrFactory) { - return createHttpBackend($browser, $xhrFactory, $browser.defer, $jsonpCallbacks, $document[0]); - }]; -} - -function createHttpBackend($browser, createXhr, $browserDefer, callbacks, rawDocument) { - // TODO(vojta): fix the signature - return function(method, url, post, callback, headers, timeout, withCredentials, responseType, eventHandlers, uploadEventHandlers) { - url = url || $browser.url(); - - if (lowercase(method) === 'jsonp') { - var callbackPath = callbacks.createCallback(url); - var jsonpDone = jsonpReq(url, callbackPath, function(status, text) { - // jsonpReq only ever sets status to 200 (OK), 404 (ERROR) or -1 (WAITING) - var response = (status === 200) && callbacks.getResponse(callbackPath); - completeRequest(callback, status, response, '', text); - callbacks.removeCallback(callbackPath); - }); - } else { - - var xhr = createXhr(method, url); - - xhr.open(method, url, true); - forEach(headers, function(value, key) { - if (isDefined(value)) { - xhr.setRequestHeader(key, value); - } - }); - - xhr.onload = function requestLoaded() { - var statusText = xhr.statusText || ''; - - // responseText is the old-school way of retrieving response (supported by IE9) - // response/responseType properties were introduced in XHR Level2 spec (supported by IE10) - var response = ('response' in xhr) ? xhr.response : xhr.responseText; - - // normalize IE9 bug (http://bugs.jquery.com/ticket/1450) - var status = xhr.status === 1223 ? 204 : xhr.status; - - // fix status code when it is 0 (0 status is undocumented). - // Occurs when accessing file resources or on Android 4.1 stock browser - // while retrieving files from application cache. - if (status === 0) { - status = response ? 200 : urlResolve(url).protocol === 'file' ? 404 : 0; - } - - completeRequest(callback, - status, - response, - xhr.getAllResponseHeaders(), - statusText); - }; - - var requestError = function() { - // The response is always empty - // See https://xhr.spec.whatwg.org/#request-error-steps and https://fetch.spec.whatwg.org/#concept-network-error - completeRequest(callback, -1, null, null, ''); - }; - - xhr.onerror = requestError; - xhr.onabort = requestError; - xhr.ontimeout = requestError; - - forEach(eventHandlers, function(value, key) { - xhr.addEventListener(key, value); - }); - - forEach(uploadEventHandlers, function(value, key) { - xhr.upload.addEventListener(key, value); - }); - - if (withCredentials) { - xhr.withCredentials = true; - } - - if (responseType) { - try { - xhr.responseType = responseType; - } catch (e) { - // WebKit added support for the json responseType value on 09/03/2013 - // https://bugs.webkit.org/show_bug.cgi?id=73648. Versions of Safari prior to 7 are - // known to throw when setting the value "json" as the response type. Other older - // browsers implementing the responseType - // - // The json response type can be ignored if not supported, because JSON payloads are - // parsed on the client-side regardless. - if (responseType !== 'json') { - throw e; - } - } - } - - xhr.send(isUndefined(post) ? null : post); - } - - if (timeout > 0) { - var timeoutId = $browserDefer(timeoutRequest, timeout); - } else if (isPromiseLike(timeout)) { - timeout.then(timeoutRequest); - } - - - function timeoutRequest() { - if (jsonpDone) { - jsonpDone(); - } - if (xhr) { - xhr.abort(); - } - } - - function completeRequest(callback, status, response, headersString, statusText) { - // cancel timeout and subsequent timeout promise resolution - if (isDefined(timeoutId)) { - $browserDefer.cancel(timeoutId); - } - jsonpDone = xhr = null; - - callback(status, response, headersString, statusText); - } - }; - - function jsonpReq(url, callbackPath, done) { - url = url.replace('JSON_CALLBACK', callbackPath); - // we can't use jQuery/jqLite here because jQuery does crazy stuff with script elements, e.g.: - // - fetches local scripts via XHR and evals them - // - adds and immediately removes script elements from the document - var script = rawDocument.createElement('script'), callback = null; - script.type = 'text/javascript'; - script.src = url; - script.async = true; - - callback = function(event) { - script.removeEventListener('load', callback); - script.removeEventListener('error', callback); - rawDocument.body.removeChild(script); - script = null; - var status = -1; - var text = 'unknown'; - - if (event) { - if (event.type === 'load' && !callbacks.wasCalled(callbackPath)) { - event = { type: 'error' }; - } - text = event.type; - status = event.type === 'error' ? 404 : 200; - } - - if (done) { - done(status, text); - } - }; - - script.addEventListener('load', callback); - script.addEventListener('error', callback); - rawDocument.body.appendChild(script); - return callback; - } -} - -var $interpolateMinErr = angular.$interpolateMinErr = minErr('$interpolate'); -$interpolateMinErr.throwNoconcat = function(text) { - throw $interpolateMinErr('noconcat', - 'Error while interpolating: {0}\nStrict Contextual Escaping disallows ' + - 'interpolations that concatenate multiple expressions when a trusted value is ' + - 'required. See http://docs.angularjs.org/api/ng.$sce', text); -}; - -$interpolateMinErr.interr = function(text, err) { - return $interpolateMinErr('interr', 'Can\'t interpolate: {0}\n{1}', text, err.toString()); -}; - -/** - * @ngdoc provider - * @name $interpolateProvider - * @this - * - * @description - * - * Used for configuring the interpolation markup. Defaults to `{{` and `}}`. - * - *
- * This feature is sometimes used to mix different markup languages, e.g. to wrap an Angular - * template within a Python Jinja template (or any other template language). Mixing templating - * languages is **very dangerous**. The embedding template language will not safely escape Angular - * expressions, so any user-controlled values in the template will cause Cross Site Scripting (XSS) - * security bugs! - *
- * - * @example - - - -
- //demo.label// -
- - - it('should interpolate binding with custom symbols', function() { - expect(element(by.binding('demo.label')).getText()).toBe('This binding is brought you by // interpolation symbols.'); - }); - - - */ -function $InterpolateProvider() { - var startSymbol = '{{'; - var endSymbol = '}}'; - - /** - * @ngdoc method - * @name $interpolateProvider#startSymbol - * @description - * Symbol to denote start of expression in the interpolated string. Defaults to `{{`. - * - * @param {string=} value new value to set the starting symbol to. - * @returns {string|self} Returns the symbol when used as getter and self if used as setter. - */ - this.startSymbol = function(value) { - if (value) { - startSymbol = value; - return this; - } else { - return startSymbol; - } - }; - - /** - * @ngdoc method - * @name $interpolateProvider#endSymbol - * @description - * Symbol to denote the end of expression in the interpolated string. Defaults to `}}`. - * - * @param {string=} value new value to set the ending symbol to. - * @returns {string|self} Returns the symbol when used as getter and self if used as setter. - */ - this.endSymbol = function(value) { - if (value) { - endSymbol = value; - return this; - } else { - return endSymbol; - } - }; - - - this.$get = ['$parse', '$exceptionHandler', '$sce', function($parse, $exceptionHandler, $sce) { - var startSymbolLength = startSymbol.length, - endSymbolLength = endSymbol.length, - escapedStartRegexp = new RegExp(startSymbol.replace(/./g, escape), 'g'), - escapedEndRegexp = new RegExp(endSymbol.replace(/./g, escape), 'g'); - - function escape(ch) { - return '\\\\\\' + ch; - } - - function unescapeText(text) { - return text.replace(escapedStartRegexp, startSymbol). - replace(escapedEndRegexp, endSymbol); - } - - // TODO: this is the same as the constantWatchDelegate in parse.js - function constantWatchDelegate(scope, listener, objectEquality, constantInterp) { - var unwatch = scope.$watch(function constantInterpolateWatch(scope) { - unwatch(); - return constantInterp(scope); - }, listener, objectEquality); - return unwatch; - } - - /** - * @ngdoc service - * @name $interpolate - * @kind function - * - * @requires $parse - * @requires $sce - * - * @description - * - * Compiles a string with markup into an interpolation function. This service is used by the - * HTML {@link ng.$compile $compile} service for data binding. See - * {@link ng.$interpolateProvider $interpolateProvider} for configuring the - * interpolation markup. - * - * - * ```js - * var $interpolate = ...; // injected - * var exp = $interpolate('Hello {{name | uppercase}}!'); - * expect(exp({name:'Angular'})).toEqual('Hello ANGULAR!'); - * ``` - * - * `$interpolate` takes an optional fourth argument, `allOrNothing`. If `allOrNothing` is - * `true`, the interpolation function will return `undefined` unless all embedded expressions - * evaluate to a value other than `undefined`. - * - * ```js - * var $interpolate = ...; // injected - * var context = {greeting: 'Hello', name: undefined }; - * - * // default "forgiving" mode - * var exp = $interpolate('{{greeting}} {{name}}!'); - * expect(exp(context)).toEqual('Hello !'); - * - * // "allOrNothing" mode - * exp = $interpolate('{{greeting}} {{name}}!', false, null, true); - * expect(exp(context)).toBeUndefined(); - * context.name = 'Angular'; - * expect(exp(context)).toEqual('Hello Angular!'); - * ``` - * - * `allOrNothing` is useful for interpolating URLs. `ngSrc` and `ngSrcset` use this behavior. - * - * #### Escaped Interpolation - * $interpolate provides a mechanism for escaping interpolation markers. Start and end markers - * can be escaped by preceding each of their characters with a REVERSE SOLIDUS U+005C (backslash). - * It will be rendered as a regular start/end marker, and will not be interpreted as an expression - * or binding. - * - * This enables web-servers to prevent script injection attacks and defacing attacks, to some - * degree, while also enabling code examples to work without relying on the - * {@link ng.directive:ngNonBindable ngNonBindable} directive. - * - * **For security purposes, it is strongly encouraged that web servers escape user-supplied data, - * replacing angle brackets (<, >) with &lt; and &gt; respectively, and replacing all - * interpolation start/end markers with their escaped counterparts.** - * - * Escaped interpolation markers are only replaced with the actual interpolation markers in rendered - * output when the $interpolate service processes the text. So, for HTML elements interpolated - * by {@link ng.$compile $compile}, or otherwise interpolated with the `mustHaveExpression` parameter - * set to `true`, the interpolated text must contain an unescaped interpolation expression. As such, - * this is typically useful only when user-data is used in rendering a template from the server, or - * when otherwise untrusted data is used by a directive. - * - * - * - *
- *

{{apptitle}}: \{\{ username = "defaced value"; \}\} - *

- *

{{username}} attempts to inject code which will deface the - * application, but fails to accomplish their task, because the server has correctly - * escaped the interpolation start/end markers with REVERSE SOLIDUS U+005C (backslash) - * characters.

- *

Instead, the result of the attempted script injection is visible, and can be removed - * from the database by an administrator.

- *
- * - * - * - * @knownIssue - * It is currently not possible for an interpolated expression to contain the interpolation end - * symbol. For example, `{{ '}}' }}` will be incorrectly interpreted as `{{ ' }}` + `' }}`, i.e. - * an interpolated expression consisting of a single-quote (`'`) and the `' }}` string. - * - * @knownIssue - * All directives and components must use the standard `{{` `}}` interpolation symbols - * in their templates. If you change the application interpolation symbols the {@link $compile} - * service will attempt to denormalize the standard symbols to the custom symbols. - * The denormalization process is not clever enough to know not to replace instances of the standard - * symbols where they would not normally be treated as interpolation symbols. For example in the following - * code snippet the closing braces of the literal object will get incorrectly denormalized: - * - * ``` - *
- * ``` - * - * See https://github.com/angular/angular.js/pull/14610#issuecomment-219401099 for more information. - * - * @param {string} text The text with markup to interpolate. - * @param {boolean=} mustHaveExpression if set to true then the interpolation string must have - * embedded expression in order to return an interpolation function. Strings with no - * embedded expression will return null for the interpolation function. - * @param {string=} trustedContext when provided, the returned function passes the interpolated - * result through {@link ng.$sce#getTrusted $sce.getTrusted(interpolatedResult, - * trustedContext)} before returning it. Refer to the {@link ng.$sce $sce} service that - * provides Strict Contextual Escaping for details. - * @param {boolean=} allOrNothing if `true`, then the returned function returns undefined - * unless all embedded expressions evaluate to a value other than `undefined`. - * @returns {function(context)} an interpolation function which is used to compute the - * interpolated string. The function has these parameters: - * - * - `context`: evaluation context for all expressions embedded in the interpolated text - */ - function $interpolate(text, mustHaveExpression, trustedContext, allOrNothing) { - // Provide a quick exit and simplified result function for text with no interpolation - if (!text.length || text.indexOf(startSymbol) === -1) { - var constantInterp; - if (!mustHaveExpression) { - var unescapedText = unescapeText(text); - constantInterp = valueFn(unescapedText); - constantInterp.exp = text; - constantInterp.expressions = []; - constantInterp.$$watchDelegate = constantWatchDelegate; - } - return constantInterp; - } - - allOrNothing = !!allOrNothing; - var startIndex, - endIndex, - index = 0, - expressions = [], - parseFns = [], - textLength = text.length, - exp, - concat = [], - expressionPositions = []; - - while (index < textLength) { - if (((startIndex = text.indexOf(startSymbol, index)) !== -1) && - ((endIndex = text.indexOf(endSymbol, startIndex + startSymbolLength)) !== -1)) { - if (index !== startIndex) { - concat.push(unescapeText(text.substring(index, startIndex))); - } - exp = text.substring(startIndex + startSymbolLength, endIndex); - expressions.push(exp); - parseFns.push($parse(exp, parseStringifyInterceptor)); - index = endIndex + endSymbolLength; - expressionPositions.push(concat.length); - concat.push(''); - } else { - // we did not find an interpolation, so we have to add the remainder to the separators array - if (index !== textLength) { - concat.push(unescapeText(text.substring(index))); - } - break; - } - } - - // Concatenating expressions makes it hard to reason about whether some combination of - // concatenated values are unsafe to use and could easily lead to XSS. By requiring that a - // single expression be used for iframe[src], object[src], etc., we ensure that the value - // that's used is assigned or constructed by some JS code somewhere that is more testable or - // make it obvious that you bound the value to some user controlled value. This helps reduce - // the load when auditing for XSS issues. - if (trustedContext && concat.length > 1) { - $interpolateMinErr.throwNoconcat(text); - } - - if (!mustHaveExpression || expressions.length) { - var compute = function(values) { - for (var i = 0, ii = expressions.length; i < ii; i++) { - if (allOrNothing && isUndefined(values[i])) return; - concat[expressionPositions[i]] = values[i]; - } - return concat.join(''); - }; - - var getValue = function(value) { - return trustedContext ? - $sce.getTrusted(trustedContext, value) : - $sce.valueOf(value); - }; - - return extend(function interpolationFn(context) { - var i = 0; - var ii = expressions.length; - var values = new Array(ii); - - try { - for (; i < ii; i++) { - values[i] = parseFns[i](context); - } - - return compute(values); - } catch (err) { - $exceptionHandler($interpolateMinErr.interr(text, err)); - } - - }, { - // all of these properties are undocumented for now - exp: text, //just for compatibility with regular watchers created via $watch - expressions: expressions, - $$watchDelegate: function(scope, listener) { - var lastValue; - return scope.$watchGroup(parseFns, /** @this */ function interpolateFnWatcher(values, oldValues) { - var currValue = compute(values); - if (isFunction(listener)) { - listener.call(this, currValue, values !== oldValues ? lastValue : currValue, scope); - } - lastValue = currValue; - }); - } - }); - } - - function parseStringifyInterceptor(value) { - try { - value = getValue(value); - return allOrNothing && !isDefined(value) ? value : stringify(value); - } catch (err) { - $exceptionHandler($interpolateMinErr.interr(text, err)); - } - } - } - - - /** - * @ngdoc method - * @name $interpolate#startSymbol - * @description - * Symbol to denote the start of expression in the interpolated string. Defaults to `{{`. - * - * Use {@link ng.$interpolateProvider#startSymbol `$interpolateProvider.startSymbol`} to change - * the symbol. - * - * @returns {string} start symbol. - */ - $interpolate.startSymbol = function() { - return startSymbol; - }; - - - /** - * @ngdoc method - * @name $interpolate#endSymbol - * @description - * Symbol to denote the end of expression in the interpolated string. Defaults to `}}`. - * - * Use {@link ng.$interpolateProvider#endSymbol `$interpolateProvider.endSymbol`} to change - * the symbol. - * - * @returns {string} end symbol. - */ - $interpolate.endSymbol = function() { - return endSymbol; - }; - - return $interpolate; - }]; -} - -/** @this */ -function $IntervalProvider() { - this.$get = ['$rootScope', '$window', '$q', '$$q', '$browser', - function($rootScope, $window, $q, $$q, $browser) { - var intervals = {}; - - - /** - * @ngdoc service - * @name $interval - * - * @description - * Angular's wrapper for `window.setInterval`. The `fn` function is executed every `delay` - * milliseconds. - * - * The return value of registering an interval function is a promise. This promise will be - * notified upon each tick of the interval, and will be resolved after `count` iterations, or - * run indefinitely if `count` is not defined. The value of the notification will be the - * number of iterations that have run. - * To cancel an interval, call `$interval.cancel(promise)`. - * - * In tests you can use {@link ngMock.$interval#flush `$interval.flush(millis)`} to - * move forward by `millis` milliseconds and trigger any functions scheduled to run in that - * time. - * - *
- * **Note**: Intervals created by this service must be explicitly destroyed when you are finished - * with them. In particular they are not automatically destroyed when a controller's scope or a - * directive's element are destroyed. - * You should take this into consideration and make sure to always cancel the interval at the - * appropriate moment. See the example below for more details on how and when to do this. - *
- * - * @param {function()} fn A function that should be called repeatedly. - * @param {number} delay Number of milliseconds between each function call. - * @param {number=} [count=0] Number of times to repeat. If not set, or 0, will repeat - * indefinitely. - * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. - * @param {...*=} Pass additional parameters to the executed function. - * @returns {promise} A promise which will be notified on each iteration. - * - * @example - * - * - * - * - *
- *
- *
- * Current time is: - *
- * Blood 1 : {{blood_1}} - * Blood 2 : {{blood_2}} - * - * - * - *
- *
- * - * - * - */ - function interval(fn, delay, count, invokeApply) { - var hasParams = arguments.length > 4, - args = hasParams ? sliceArgs(arguments, 4) : [], - setInterval = $window.setInterval, - clearInterval = $window.clearInterval, - iteration = 0, - skipApply = (isDefined(invokeApply) && !invokeApply), - deferred = (skipApply ? $$q : $q).defer(), - promise = deferred.promise; - - count = isDefined(count) ? count : 0; - - promise.$$intervalId = setInterval(function tick() { - if (skipApply) { - $browser.defer(callback); - } else { - $rootScope.$evalAsync(callback); - } - deferred.notify(iteration++); - - if (count > 0 && iteration >= count) { - deferred.resolve(iteration); - clearInterval(promise.$$intervalId); - delete intervals[promise.$$intervalId]; - } - - if (!skipApply) $rootScope.$apply(); - - }, delay); - - intervals[promise.$$intervalId] = deferred; - - return promise; - - function callback() { - if (!hasParams) { - fn(iteration); - } else { - fn.apply(null, args); - } - } - } - - - /** - * @ngdoc method - * @name $interval#cancel - * - * @description - * Cancels a task associated with the `promise`. - * - * @param {Promise=} promise returned by the `$interval` function. - * @returns {boolean} Returns `true` if the task was successfully canceled. - */ - interval.cancel = function(promise) { - if (promise && promise.$$intervalId in intervals) { - // Interval cancels should not report as unhandled promise. - intervals[promise.$$intervalId].promise.catch(noop); - intervals[promise.$$intervalId].reject('canceled'); - $window.clearInterval(promise.$$intervalId); - delete intervals[promise.$$intervalId]; - return true; - } - return false; - }; - - return interval; - }]; -} - -/** - * @ngdoc service - * @name $jsonpCallbacks - * @requires $window - * @description - * This service handles the lifecycle of callbacks to handle JSONP requests. - * Override this service if you wish to customise where the callbacks are stored and - * how they vary compared to the requested url. - */ -var $jsonpCallbacksProvider = /** @this */ function() { - this.$get = ['$window', function($window) { - var callbacks = $window.angular.callbacks; - var callbackMap = {}; - - function createCallback(callbackId) { - var callback = function(data) { - callback.data = data; - callback.called = true; - }; - callback.id = callbackId; - return callback; - } - - return { - /** - * @ngdoc method - * @name $jsonpCallbacks#createCallback - * @param {string} url the url of the JSONP request - * @returns {string} the callback path to send to the server as part of the JSONP request - * @description - * {@link $httpBackend} calls this method to create a callback and get hold of the path to the callback - * to pass to the server, which will be used to call the callback with its payload in the JSONP response. - */ - createCallback: function(url) { - var callbackId = '_' + (callbacks.$$counter++).toString(36); - var callbackPath = 'angular.callbacks.' + callbackId; - var callback = createCallback(callbackId); - callbackMap[callbackPath] = callbacks[callbackId] = callback; - return callbackPath; - }, - /** - * @ngdoc method - * @name $jsonpCallbacks#wasCalled - * @param {string} callbackPath the path to the callback that was sent in the JSONP request - * @returns {boolean} whether the callback has been called, as a result of the JSONP response - * @description - * {@link $httpBackend} calls this method to find out whether the JSONP response actually called the - * callback that was passed in the request. - */ - wasCalled: function(callbackPath) { - return callbackMap[callbackPath].called; - }, - /** - * @ngdoc method - * @name $jsonpCallbacks#getResponse - * @param {string} callbackPath the path to the callback that was sent in the JSONP request - * @returns {*} the data received from the response via the registered callback - * @description - * {@link $httpBackend} calls this method to get hold of the data that was provided to the callback - * in the JSONP response. - */ - getResponse: function(callbackPath) { - return callbackMap[callbackPath].data; - }, - /** - * @ngdoc method - * @name $jsonpCallbacks#removeCallback - * @param {string} callbackPath the path to the callback that was sent in the JSONP request - * @description - * {@link $httpBackend} calls this method to remove the callback after the JSONP request has - * completed or timed-out. - */ - removeCallback: function(callbackPath) { - var callback = callbackMap[callbackPath]; - delete callbacks[callback.id]; - delete callbackMap[callbackPath]; - } - }; - }]; -}; - -/** - * @ngdoc service - * @name $locale - * - * @description - * $locale service provides localization rules for various Angular components. As of right now the - * only public api is: - * - * * `id` – `{string}` – locale id formatted as `languageId-countryId` (e.g. `en-us`) - */ - -var PATH_MATCH = /^([^?#]*)(\?([^#]*))?(#(.*))?$/, - DEFAULT_PORTS = {'http': 80, 'https': 443, 'ftp': 21}; -var $locationMinErr = minErr('$location'); - - -/** - * Encode path using encodeUriSegment, ignoring forward slashes - * - * @param {string} path Path to encode - * @returns {string} - */ -function encodePath(path) { - var segments = path.split('/'), - i = segments.length; - - while (i--) { - segments[i] = encodeUriSegment(segments[i]); - } - - return segments.join('/'); -} - -function parseAbsoluteUrl(absoluteUrl, locationObj) { - var parsedUrl = urlResolve(absoluteUrl); - - locationObj.$$protocol = parsedUrl.protocol; - locationObj.$$host = parsedUrl.hostname; - locationObj.$$port = toInt(parsedUrl.port) || DEFAULT_PORTS[parsedUrl.protocol] || null; -} - -var DOUBLE_SLASH_REGEX = /^\s*[\\/]{2,}/; -function parseAppUrl(url, locationObj) { - - if (DOUBLE_SLASH_REGEX.test(url)) { - throw $locationMinErr('badpath', 'Invalid url "{0}".', url); - } - - var prefixed = (url.charAt(0) !== '/'); - if (prefixed) { - url = '/' + url; - } - var match = urlResolve(url); - locationObj.$$path = decodeURIComponent(prefixed && match.pathname.charAt(0) === '/' ? - match.pathname.substring(1) : match.pathname); - locationObj.$$search = parseKeyValue(match.search); - locationObj.$$hash = decodeURIComponent(match.hash); - - // make sure path starts with '/'; - if (locationObj.$$path && locationObj.$$path.charAt(0) !== '/') { - locationObj.$$path = '/' + locationObj.$$path; - } -} - -function startsWith(str, search) { - return str.slice(0, search.length) === search; -} - -/** - * - * @param {string} base - * @param {string} url - * @returns {string} returns text from `url` after `base` or `undefined` if it does not begin with - * the expected string. - */ -function stripBaseUrl(base, url) { - if (startsWith(url, base)) { - return url.substr(base.length); - } -} - - -function stripHash(url) { - var index = url.indexOf('#'); - return index === -1 ? url : url.substr(0, index); -} - -function trimEmptyHash(url) { - return url.replace(/(#.+)|#$/, '$1'); -} - - -function stripFile(url) { - return url.substr(0, stripHash(url).lastIndexOf('/') + 1); -} - -/* return the server only (scheme://host:port) */ -function serverBase(url) { - return url.substring(0, url.indexOf('/', url.indexOf('//') + 2)); -} - - -/** - * LocationHtml5Url represents a URL - * This object is exposed as $location service when HTML5 mode is enabled and supported - * - * @constructor - * @param {string} appBase application base URL - * @param {string} appBaseNoFile application base URL stripped of any filename - * @param {string} basePrefix URL path prefix - */ -function LocationHtml5Url(appBase, appBaseNoFile, basePrefix) { - this.$$html5 = true; - basePrefix = basePrefix || ''; - parseAbsoluteUrl(appBase, this); - - - /** - * Parse given HTML5 (regular) URL string into properties - * @param {string} url HTML5 URL - * @private - */ - this.$$parse = function(url) { - var pathUrl = stripBaseUrl(appBaseNoFile, url); - if (!isString(pathUrl)) { - throw $locationMinErr('ipthprfx', 'Invalid url "{0}", missing path prefix "{1}".', url, - appBaseNoFile); - } - - parseAppUrl(pathUrl, this); - - if (!this.$$path) { - this.$$path = '/'; - } - - this.$$compose(); - }; - - /** - * Compose url and update `absUrl` property - * @private - */ - this.$$compose = function() { - var search = toKeyValue(this.$$search), - hash = this.$$hash ? '#' + encodeUriSegment(this.$$hash) : ''; - - this.$$url = encodePath(this.$$path) + (search ? '?' + search : '') + hash; - this.$$absUrl = appBaseNoFile + this.$$url.substr(1); // first char is always '/' - }; - - this.$$parseLinkUrl = function(url, relHref) { - if (relHref && relHref[0] === '#') { - // special case for links to hash fragments: - // keep the old url and only replace the hash fragment - this.hash(relHref.slice(1)); - return true; - } - var appUrl, prevAppUrl; - var rewrittenUrl; - - - if (isDefined(appUrl = stripBaseUrl(appBase, url))) { - prevAppUrl = appUrl; - if (basePrefix && isDefined(appUrl = stripBaseUrl(basePrefix, appUrl))) { - rewrittenUrl = appBaseNoFile + (stripBaseUrl('/', appUrl) || appUrl); - } else { - rewrittenUrl = appBase + prevAppUrl; - } - } else if (isDefined(appUrl = stripBaseUrl(appBaseNoFile, url))) { - rewrittenUrl = appBaseNoFile + appUrl; - } else if (appBaseNoFile === url + '/') { - rewrittenUrl = appBaseNoFile; - } - if (rewrittenUrl) { - this.$$parse(rewrittenUrl); - } - return !!rewrittenUrl; - }; -} - - -/** - * LocationHashbangUrl represents URL - * This object is exposed as $location service when developer doesn't opt into html5 mode. - * It also serves as the base class for html5 mode fallback on legacy browsers. - * - * @constructor - * @param {string} appBase application base URL - * @param {string} appBaseNoFile application base URL stripped of any filename - * @param {string} hashPrefix hashbang prefix - */ -function LocationHashbangUrl(appBase, appBaseNoFile, hashPrefix) { - - parseAbsoluteUrl(appBase, this); - - - /** - * Parse given hashbang URL into properties - * @param {string} url Hashbang URL - * @private - */ - this.$$parse = function(url) { - var withoutBaseUrl = stripBaseUrl(appBase, url) || stripBaseUrl(appBaseNoFile, url); - var withoutHashUrl; - - if (!isUndefined(withoutBaseUrl) && withoutBaseUrl.charAt(0) === '#') { - - // The rest of the URL starts with a hash so we have - // got either a hashbang path or a plain hash fragment - withoutHashUrl = stripBaseUrl(hashPrefix, withoutBaseUrl); - if (isUndefined(withoutHashUrl)) { - // There was no hashbang prefix so we just have a hash fragment - withoutHashUrl = withoutBaseUrl; - } - - } else { - // There was no hashbang path nor hash fragment: - // If we are in HTML5 mode we use what is left as the path; - // Otherwise we ignore what is left - if (this.$$html5) { - withoutHashUrl = withoutBaseUrl; - } else { - withoutHashUrl = ''; - if (isUndefined(withoutBaseUrl)) { - appBase = url; - this.replace(); - } - } - } - - parseAppUrl(withoutHashUrl, this); - - this.$$path = removeWindowsDriveName(this.$$path, withoutHashUrl, appBase); - - this.$$compose(); - - /* - * In Windows, on an anchor node on documents loaded from - * the filesystem, the browser will return a pathname - * prefixed with the drive name ('/C:/path') when a - * pathname without a drive is set: - * * a.setAttribute('href', '/foo') - * * a.pathname === '/C:/foo' //true - * - * Inside of Angular, we're always using pathnames that - * do not include drive names for routing. - */ - function removeWindowsDriveName(path, url, base) { - /* - Matches paths for file protocol on windows, - such as /C:/foo/bar, and captures only /foo/bar. - */ - var windowsFilePathExp = /^\/[A-Z]:(\/.*)/; - - var firstPathSegmentMatch; - - //Get the relative path from the input URL. - if (startsWith(url, base)) { - url = url.replace(base, ''); - } - - // The input URL intentionally contains a first path segment that ends with a colon. - if (windowsFilePathExp.exec(url)) { - return path; - } - - firstPathSegmentMatch = windowsFilePathExp.exec(path); - return firstPathSegmentMatch ? firstPathSegmentMatch[1] : path; - } - }; - - /** - * Compose hashbang URL and update `absUrl` property - * @private - */ - this.$$compose = function() { - var search = toKeyValue(this.$$search), - hash = this.$$hash ? '#' + encodeUriSegment(this.$$hash) : ''; - - this.$$url = encodePath(this.$$path) + (search ? '?' + search : '') + hash; - this.$$absUrl = appBase + (this.$$url ? hashPrefix + this.$$url : ''); - }; - - this.$$parseLinkUrl = function(url, relHref) { - if (stripHash(appBase) === stripHash(url)) { - this.$$parse(url); - return true; - } - return false; - }; -} - - -/** - * LocationHashbangUrl represents URL - * This object is exposed as $location service when html5 history api is enabled but the browser - * does not support it. - * - * @constructor - * @param {string} appBase application base URL - * @param {string} appBaseNoFile application base URL stripped of any filename - * @param {string} hashPrefix hashbang prefix - */ -function LocationHashbangInHtml5Url(appBase, appBaseNoFile, hashPrefix) { - this.$$html5 = true; - LocationHashbangUrl.apply(this, arguments); - - this.$$parseLinkUrl = function(url, relHref) { - if (relHref && relHref[0] === '#') { - // special case for links to hash fragments: - // keep the old url and only replace the hash fragment - this.hash(relHref.slice(1)); - return true; - } - - var rewrittenUrl; - var appUrl; - - if (appBase === stripHash(url)) { - rewrittenUrl = url; - } else if ((appUrl = stripBaseUrl(appBaseNoFile, url))) { - rewrittenUrl = appBase + hashPrefix + appUrl; - } else if (appBaseNoFile === url + '/') { - rewrittenUrl = appBaseNoFile; - } - if (rewrittenUrl) { - this.$$parse(rewrittenUrl); - } - return !!rewrittenUrl; - }; - - this.$$compose = function() { - var search = toKeyValue(this.$$search), - hash = this.$$hash ? '#' + encodeUriSegment(this.$$hash) : ''; - - this.$$url = encodePath(this.$$path) + (search ? '?' + search : '') + hash; - // include hashPrefix in $$absUrl when $$url is empty so IE9 does not reload page because of removal of '#' - this.$$absUrl = appBase + hashPrefix + this.$$url; - }; - -} - - -var locationPrototype = { - - /** - * Ensure absolute URL is initialized. - * @private - */ - $$absUrl:'', - - /** - * Are we in html5 mode? - * @private - */ - $$html5: false, - - /** - * Has any change been replacing? - * @private - */ - $$replace: false, - - /** - * @ngdoc method - * @name $location#absUrl - * - * @description - * This method is getter only. - * - * Return full URL representation with all segments encoded according to rules specified in - * [RFC 3986](http://www.ietf.org/rfc/rfc3986.txt). - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var absUrl = $location.absUrl(); - * // => "http://example.com/#/some/path?foo=bar&baz=xoxo" - * ``` - * - * @return {string} full URL - */ - absUrl: locationGetter('$$absUrl'), - - /** - * @ngdoc method - * @name $location#url - * - * @description - * This method is getter / setter. - * - * Return URL (e.g. `/path?a=b#hash`) when called without any parameter. - * - * Change path, search and hash, when called with parameter and return `$location`. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var url = $location.url(); - * // => "/some/path?foo=bar&baz=xoxo" - * ``` - * - * @param {string=} url New URL without base prefix (e.g. `/path?a=b#hash`) - * @return {string} url - */ - url: function(url) { - if (isUndefined(url)) { - return this.$$url; - } - - var match = PATH_MATCH.exec(url); - if (match[1] || url === '') this.path(decodeURIComponent(match[1])); - if (match[2] || match[1] || url === '') this.search(match[3] || ''); - this.hash(match[5] || ''); - - return this; - }, - - /** - * @ngdoc method - * @name $location#protocol - * - * @description - * This method is getter only. - * - * Return protocol of current URL. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var protocol = $location.protocol(); - * // => "http" - * ``` - * - * @return {string} protocol of current URL - */ - protocol: locationGetter('$$protocol'), - - /** - * @ngdoc method - * @name $location#host - * - * @description - * This method is getter only. - * - * Return host of current URL. - * - * Note: compared to the non-angular version `location.host` which returns `hostname:port`, this returns the `hostname` portion only. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var host = $location.host(); - * // => "example.com" - * - * // given URL http://user:password@example.com:8080/#/some/path?foo=bar&baz=xoxo - * host = $location.host(); - * // => "example.com" - * host = location.host; - * // => "example.com:8080" - * ``` - * - * @return {string} host of current URL. - */ - host: locationGetter('$$host'), - - /** - * @ngdoc method - * @name $location#port - * - * @description - * This method is getter only. - * - * Return port of current URL. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var port = $location.port(); - * // => 80 - * ``` - * - * @return {Number} port - */ - port: locationGetter('$$port'), - - /** - * @ngdoc method - * @name $location#path - * - * @description - * This method is getter / setter. - * - * Return path of current URL when called without any parameter. - * - * Change path when called with parameter and return `$location`. - * - * Note: Path should always begin with forward slash (/), this method will add the forward slash - * if it is missing. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var path = $location.path(); - * // => "/some/path" - * ``` - * - * @param {(string|number)=} path New path - * @return {(string|object)} path if called with no parameters, or `$location` if called with a parameter - */ - path: locationGetterSetter('$$path', function(path) { - path = path !== null ? path.toString() : ''; - return path.charAt(0) === '/' ? path : '/' + path; - }), - - /** - * @ngdoc method - * @name $location#search - * - * @description - * This method is getter / setter. - * - * Return search part (as object) of current URL when called without any parameter. - * - * Change search part when called with parameter and return `$location`. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo - * var searchObject = $location.search(); - * // => {foo: 'bar', baz: 'xoxo'} - * - * // set foo to 'yipee' - * $location.search('foo', 'yipee'); - * // $location.search() => {foo: 'yipee', baz: 'xoxo'} - * ``` - * - * @param {string|Object.|Object.>} search New search params - string or - * hash object. - * - * When called with a single argument the method acts as a setter, setting the `search` component - * of `$location` to the specified value. - * - * If the argument is a hash object containing an array of values, these values will be encoded - * as duplicate search parameters in the URL. - * - * @param {(string|Number|Array|boolean)=} paramValue If `search` is a string or number, then `paramValue` - * will override only a single search property. - * - * If `paramValue` is an array, it will override the property of the `search` component of - * `$location` specified via the first argument. - * - * If `paramValue` is `null`, the property specified via the first argument will be deleted. - * - * If `paramValue` is `true`, the property specified via the first argument will be added with no - * value nor trailing equal sign. - * - * @return {Object} If called with no arguments returns the parsed `search` object. If called with - * one or more arguments returns `$location` object itself. - */ - search: function(search, paramValue) { - switch (arguments.length) { - case 0: - return this.$$search; - case 1: - if (isString(search) || isNumber(search)) { - search = search.toString(); - this.$$search = parseKeyValue(search); - } else if (isObject(search)) { - search = copy(search, {}); - // remove object undefined or null properties - forEach(search, function(value, key) { - if (value == null) delete search[key]; - }); - - this.$$search = search; - } else { - throw $locationMinErr('isrcharg', - 'The first argument of the `$location#search()` call must be a string or an object.'); - } - break; - default: - if (isUndefined(paramValue) || paramValue === null) { - delete this.$$search[search]; - } else { - this.$$search[search] = paramValue; - } - } - - this.$$compose(); - return this; - }, - - /** - * @ngdoc method - * @name $location#hash - * - * @description - * This method is getter / setter. - * - * Returns the hash fragment when called without any parameters. - * - * Changes the hash fragment when called with a parameter and returns `$location`. - * - * - * ```js - * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo#hashValue - * var hash = $location.hash(); - * // => "hashValue" - * ``` - * - * @param {(string|number)=} hash New hash fragment - * @return {string} hash - */ - hash: locationGetterSetter('$$hash', function(hash) { - return hash !== null ? hash.toString() : ''; - }), - - /** - * @ngdoc method - * @name $location#replace - * - * @description - * If called, all changes to $location during the current `$digest` will replace the current history - * record, instead of adding a new one. - */ - replace: function() { - this.$$replace = true; - return this; - } -}; - -forEach([LocationHashbangInHtml5Url, LocationHashbangUrl, LocationHtml5Url], function(Location) { - Location.prototype = Object.create(locationPrototype); - - /** - * @ngdoc method - * @name $location#state - * - * @description - * This method is getter / setter. - * - * Return the history state object when called without any parameter. - * - * Change the history state object when called with one parameter and return `$location`. - * The state object is later passed to `pushState` or `replaceState`. - * - * NOTE: This method is supported only in HTML5 mode and only in browsers supporting - * the HTML5 History API (i.e. methods `pushState` and `replaceState`). If you need to support - * older browsers (like IE9 or Android < 4.0), don't use this method. - * - * @param {object=} state State object for pushState or replaceState - * @return {object} state - */ - Location.prototype.state = function(state) { - if (!arguments.length) { - return this.$$state; - } - - if (Location !== LocationHtml5Url || !this.$$html5) { - throw $locationMinErr('nostate', 'History API state support is available only ' + - 'in HTML5 mode and only in browsers supporting HTML5 History API'); - } - // The user might modify `stateObject` after invoking `$location.state(stateObject)` - // but we're changing the $$state reference to $browser.state() during the $digest - // so the modification window is narrow. - this.$$state = isUndefined(state) ? null : state; - - return this; - }; -}); - - -function locationGetter(property) { - return /** @this */ function() { - return this[property]; - }; -} - - -function locationGetterSetter(property, preprocess) { - return /** @this */ function(value) { - if (isUndefined(value)) { - return this[property]; - } - - this[property] = preprocess(value); - this.$$compose(); - - return this; - }; -} - - -/** - * @ngdoc service - * @name $location - * - * @requires $rootElement - * - * @description - * The $location service parses the URL in the browser address bar (based on the - * [window.location](https://developer.mozilla.org/en/window.location)) and makes the URL - * available to your application. Changes to the URL in the address bar are reflected into - * $location service and changes to $location are reflected into the browser address bar. - * - * **The $location service:** - * - * - Exposes the current URL in the browser address bar, so you can - * - Watch and observe the URL. - * - Change the URL. - * - Synchronizes the URL with the browser when the user - * - Changes the address bar. - * - Clicks the back or forward button (or clicks a History link). - * - Clicks on a link. - * - Represents the URL object as a set of methods (protocol, host, port, path, search, hash). - * - * For more information see {@link guide/$location Developer Guide: Using $location} - */ - -/** - * @ngdoc provider - * @name $locationProvider - * @this - * - * @description - * Use the `$locationProvider` to configure how the application deep linking paths are stored. - */ -function $LocationProvider() { - var hashPrefix = '!', - html5Mode = { - enabled: false, - requireBase: true, - rewriteLinks: true - }; - - /** - * @ngdoc method - * @name $locationProvider#hashPrefix - * @description - * The default value for the prefix is `'!'`. - * @param {string=} prefix Prefix for hash part (containing path and search) - * @returns {*} current value if used as getter or itself (chaining) if used as setter - */ - this.hashPrefix = function(prefix) { - if (isDefined(prefix)) { - hashPrefix = prefix; - return this; - } else { - return hashPrefix; - } - }; - - /** - * @ngdoc method - * @name $locationProvider#html5Mode - * @description - * @param {(boolean|Object)=} mode If boolean, sets `html5Mode.enabled` to value. - * If object, sets `enabled`, `requireBase` and `rewriteLinks` to respective values. Supported - * properties: - * - **enabled** – `{boolean}` – (default: false) If true, will rely on `history.pushState` to - * change urls where supported. Will fall back to hash-prefixed paths in browsers that do not - * support `pushState`. - * - **requireBase** - `{boolean}` - (default: `true`) When html5Mode is enabled, specifies - * whether or not a tag is required to be present. If `enabled` and `requireBase` are - * true, and a base tag is not present, an error will be thrown when `$location` is injected. - * See the {@link guide/$location $location guide for more information} - * - **rewriteLinks** - `{boolean|string}` - (default: `true`) When html5Mode is enabled, - * enables/disables URL rewriting for relative links. If set to a string, URL rewriting will - * only happen on links with an attribute that matches the given string. For example, if set - * to `'internal-link'`, then the URL will only be rewritten for `` links. - * Note that [attribute name normalization](guide/directive#normalization) does not apply - * here, so `'internalLink'` will **not** match `'internal-link'`. - * - * @returns {Object} html5Mode object if used as getter or itself (chaining) if used as setter - */ - this.html5Mode = function(mode) { - if (isBoolean(mode)) { - html5Mode.enabled = mode; - return this; - } else if (isObject(mode)) { - - if (isBoolean(mode.enabled)) { - html5Mode.enabled = mode.enabled; - } - - if (isBoolean(mode.requireBase)) { - html5Mode.requireBase = mode.requireBase; - } - - if (isBoolean(mode.rewriteLinks) || isString(mode.rewriteLinks)) { - html5Mode.rewriteLinks = mode.rewriteLinks; - } - - return this; - } else { - return html5Mode; - } - }; - - /** - * @ngdoc event - * @name $location#$locationChangeStart - * @eventType broadcast on root scope - * @description - * Broadcasted before a URL will change. - * - * This change can be prevented by calling - * `preventDefault` method of the event. See {@link ng.$rootScope.Scope#$on} for more - * details about event object. Upon successful change - * {@link ng.$location#$locationChangeSuccess $locationChangeSuccess} is fired. - * - * The `newState` and `oldState` parameters may be defined only in HTML5 mode and when - * the browser supports the HTML5 History API. - * - * @param {Object} angularEvent Synthetic event object. - * @param {string} newUrl New URL - * @param {string=} oldUrl URL that was before it was changed. - * @param {string=} newState New history state object - * @param {string=} oldState History state object that was before it was changed. - */ - - /** - * @ngdoc event - * @name $location#$locationChangeSuccess - * @eventType broadcast on root scope - * @description - * Broadcasted after a URL was changed. - * - * The `newState` and `oldState` parameters may be defined only in HTML5 mode and when - * the browser supports the HTML5 History API. - * - * @param {Object} angularEvent Synthetic event object. - * @param {string} newUrl New URL - * @param {string=} oldUrl URL that was before it was changed. - * @param {string=} newState New history state object - * @param {string=} oldState History state object that was before it was changed. - */ - - this.$get = ['$rootScope', '$browser', '$sniffer', '$rootElement', '$window', - function($rootScope, $browser, $sniffer, $rootElement, $window) { - var $location, - LocationMode, - baseHref = $browser.baseHref(), // if base[href] is undefined, it defaults to '' - initialUrl = $browser.url(), - appBase; - - if (html5Mode.enabled) { - if (!baseHref && html5Mode.requireBase) { - throw $locationMinErr('nobase', - '$location in HTML5 mode requires a tag to be present!'); - } - appBase = serverBase(initialUrl) + (baseHref || '/'); - LocationMode = $sniffer.history ? LocationHtml5Url : LocationHashbangInHtml5Url; - } else { - appBase = stripHash(initialUrl); - LocationMode = LocationHashbangUrl; - } - var appBaseNoFile = stripFile(appBase); - - $location = new LocationMode(appBase, appBaseNoFile, '#' + hashPrefix); - $location.$$parseLinkUrl(initialUrl, initialUrl); - - $location.$$state = $browser.state(); - - var IGNORE_URI_REGEXP = /^\s*(javascript|mailto):/i; - - function setBrowserUrlWithFallback(url, replace, state) { - var oldUrl = $location.url(); - var oldState = $location.$$state; - try { - $browser.url(url, replace, state); - - // Make sure $location.state() returns referentially identical (not just deeply equal) - // state object; this makes possible quick checking if the state changed in the digest - // loop. Checking deep equality would be too expensive. - $location.$$state = $browser.state(); - } catch (e) { - // Restore old values if pushState fails - $location.url(oldUrl); - $location.$$state = oldState; - - throw e; - } - } - - $rootElement.on('click', function(event) { - var rewriteLinks = html5Mode.rewriteLinks; - // TODO(vojta): rewrite link when opening in new tab/window (in legacy browser) - // currently we open nice url link and redirect then - - if (!rewriteLinks || event.ctrlKey || event.metaKey || event.shiftKey || event.which === 2 || event.button === 2) return; - - var elm = jqLite(event.target); - - // traverse the DOM up to find first A tag - while (nodeName_(elm[0]) !== 'a') { - // ignore rewriting if no A tag (reached root element, or no parent - removed from document) - if (elm[0] === $rootElement[0] || !(elm = elm.parent())[0]) return; - } - - if (isString(rewriteLinks) && isUndefined(elm.attr(rewriteLinks))) return; - - var absHref = elm.prop('href'); - // get the actual href attribute - see - // http://msdn.microsoft.com/en-us/library/ie/dd347148(v=vs.85).aspx - var relHref = elm.attr('href') || elm.attr('xlink:href'); - - if (isObject(absHref) && absHref.toString() === '[object SVGAnimatedString]') { - // SVGAnimatedString.animVal should be identical to SVGAnimatedString.baseVal, unless during - // an animation. - absHref = urlResolve(absHref.animVal).href; - } - - // Ignore when url is started with javascript: or mailto: - if (IGNORE_URI_REGEXP.test(absHref)) return; - - if (absHref && !elm.attr('target') && !event.isDefaultPrevented()) { - if ($location.$$parseLinkUrl(absHref, relHref)) { - // We do a preventDefault for all urls that are part of the angular application, - // in html5mode and also without, so that we are able to abort navigation without - // getting double entries in the location history. - event.preventDefault(); - // update location manually - if ($location.absUrl() !== $browser.url()) { - $rootScope.$apply(); - // hack to work around FF6 bug 684208 when scenario runner clicks on links - $window.angular['ff-684208-preventDefault'] = true; - } - } - } - }); - - - // rewrite hashbang url <> html5 url - if (trimEmptyHash($location.absUrl()) !== trimEmptyHash(initialUrl)) { - $browser.url($location.absUrl(), true); - } - - var initializing = true; - - // update $location when $browser url changes - $browser.onUrlChange(function(newUrl, newState) { - - if (!startsWith(newUrl, appBaseNoFile)) { - // If we are navigating outside of the app then force a reload - $window.location.href = newUrl; - return; - } - - $rootScope.$evalAsync(function() { - var oldUrl = $location.absUrl(); - var oldState = $location.$$state; - var defaultPrevented; - newUrl = trimEmptyHash(newUrl); - $location.$$parse(newUrl); - $location.$$state = newState; - - defaultPrevented = $rootScope.$broadcast('$locationChangeStart', newUrl, oldUrl, - newState, oldState).defaultPrevented; - - // if the location was changed by a `$locationChangeStart` handler then stop - // processing this location change - if ($location.absUrl() !== newUrl) return; - - if (defaultPrevented) { - $location.$$parse(oldUrl); - $location.$$state = oldState; - setBrowserUrlWithFallback(oldUrl, false, oldState); - } else { - initializing = false; - afterLocationChange(oldUrl, oldState); - } - }); - if (!$rootScope.$$phase) $rootScope.$digest(); - }); - - // update browser - $rootScope.$watch(function $locationWatch() { - var oldUrl = trimEmptyHash($browser.url()); - var newUrl = trimEmptyHash($location.absUrl()); - var oldState = $browser.state(); - var currentReplace = $location.$$replace; - var urlOrStateChanged = oldUrl !== newUrl || - ($location.$$html5 && $sniffer.history && oldState !== $location.$$state); - - if (initializing || urlOrStateChanged) { - initializing = false; - - $rootScope.$evalAsync(function() { - var newUrl = $location.absUrl(); - var defaultPrevented = $rootScope.$broadcast('$locationChangeStart', newUrl, oldUrl, - $location.$$state, oldState).defaultPrevented; - - // if the location was changed by a `$locationChangeStart` handler then stop - // processing this location change - if ($location.absUrl() !== newUrl) return; - - if (defaultPrevented) { - $location.$$parse(oldUrl); - $location.$$state = oldState; - } else { - if (urlOrStateChanged) { - setBrowserUrlWithFallback(newUrl, currentReplace, - oldState === $location.$$state ? null : $location.$$state); - } - afterLocationChange(oldUrl, oldState); - } - }); - } - - $location.$$replace = false; - - // we don't need to return anything because $evalAsync will make the digest loop dirty when - // there is a change - }); - - return $location; - - function afterLocationChange(oldUrl, oldState) { - $rootScope.$broadcast('$locationChangeSuccess', $location.absUrl(), oldUrl, - $location.$$state, oldState); - } -}]; -} - -/** - * @ngdoc service - * @name $log - * @requires $window - * - * @description - * Simple service for logging. Default implementation safely writes the message - * into the browser's console (if present). - * - * The main purpose of this service is to simplify debugging and troubleshooting. - * - * The default is to log `debug` messages. You can use - * {@link ng.$logProvider ng.$logProvider#debugEnabled} to change this. - * - * @example - - - angular.module('logExample', []) - .controller('LogController', ['$scope', '$log', function($scope, $log) { - $scope.$log = $log; - $scope.message = 'Hello World!'; - }]); - - -
-

Reload this page with open console, enter text and hit the log button...

- - - - - - -
- - - */ - -/** - * @ngdoc provider - * @name $logProvider - * @this - * - * @description - * Use the `$logProvider` to configure how the application logs messages - */ -function $LogProvider() { - var debug = true, - self = this; - - /** - * @ngdoc method - * @name $logProvider#debugEnabled - * @description - * @param {boolean=} flag enable or disable debug level messages - * @returns {*} current value if used as getter or itself (chaining) if used as setter - */ - this.debugEnabled = function(flag) { - if (isDefined(flag)) { - debug = flag; - return this; - } else { - return debug; - } - }; - - this.$get = ['$window', function($window) { - return { - /** - * @ngdoc method - * @name $log#log - * - * @description - * Write a log message - */ - log: consoleLog('log'), - - /** - * @ngdoc method - * @name $log#info - * - * @description - * Write an information message - */ - info: consoleLog('info'), - - /** - * @ngdoc method - * @name $log#warn - * - * @description - * Write a warning message - */ - warn: consoleLog('warn'), - - /** - * @ngdoc method - * @name $log#error - * - * @description - * Write an error message - */ - error: consoleLog('error'), - - /** - * @ngdoc method - * @name $log#debug - * - * @description - * Write a debug message - */ - debug: (function() { - var fn = consoleLog('debug'); - - return function() { - if (debug) { - fn.apply(self, arguments); - } - }; - })() - }; - - function formatError(arg) { - if (arg instanceof Error) { - if (arg.stack) { - arg = (arg.message && arg.stack.indexOf(arg.message) === -1) - ? 'Error: ' + arg.message + '\n' + arg.stack - : arg.stack; - } else if (arg.sourceURL) { - arg = arg.message + '\n' + arg.sourceURL + ':' + arg.line; - } - } - return arg; - } - - function consoleLog(type) { - var console = $window.console || {}, - logFn = console[type] || console.log || noop, - hasApply = false; - - // Note: reading logFn.apply throws an error in IE11 in IE8 document mode. - // The reason behind this is that console.log has type "object" in IE8... - try { - hasApply = !!logFn.apply; - } catch (e) { /* empty */ } - - if (hasApply) { - return function() { - var args = []; - forEach(arguments, function(arg) { - args.push(formatError(arg)); - }); - return logFn.apply(console, args); - }; - } - - // we are IE which either doesn't have window.console => this is noop and we do nothing, - // or we are IE where console.log doesn't have apply so we log at least first 2 args - return function(arg1, arg2) { - logFn(arg1, arg2 == null ? '' : arg2); - }; - } - }]; -} - -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - * Any commits to this file should be reviewed with security in mind. * - * Changes to this file can potentially create security vulnerabilities. * - * An approval from 2 Core members with history of modifying * - * this file is required. * - * * - * Does the change somehow allow for arbitrary javascript to be executed? * - * Or allows for someone to change the prototype of built-in objects? * - * Or gives undesired access to variables likes document or window? * - * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -var $parseMinErr = minErr('$parse'); - -var objectValueOf = {}.constructor.prototype.valueOf; - -// Sandboxing Angular Expressions -// ------------------------------ -// Angular expressions are no longer sandboxed. So it is now even easier to access arbitrary JS code by -// various means such as obtaining a reference to native JS functions like the Function constructor. -// -// As an example, consider the following Angular expression: -// -// {}.toString.constructor('alert("evil JS code")') -// -// It is important to realize that if you create an expression from a string that contains user provided -// content then it is possible that your application contains a security vulnerability to an XSS style attack. -// -// See https://docs.angularjs.org/guide/security - - -function getStringValue(name) { - // Property names must be strings. This means that non-string objects cannot be used - // as keys in an object. Any non-string object, including a number, is typecasted - // into a string via the toString method. - // -- MDN, https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Operators/Property_accessors#Property_names - // - // So, to ensure that we are checking the same `name` that JavaScript would use, we cast it - // to a string. It's not always possible. If `name` is an object and its `toString` method is - // 'broken' (doesn't return a string, isn't a function, etc.), an error will be thrown: - // - // TypeError: Cannot convert object to primitive value - // - // For performance reasons, we don't catch this error here and allow it to propagate up the call - // stack. Note that you'll get the same error in JavaScript if you try to access a property using - // such a 'broken' object as a key. - return name + ''; -} - - -var OPERATORS = createMap(); -forEach('+ - * / % === !== == != < > <= >= && || ! = |'.split(' '), function(operator) { OPERATORS[operator] = true; }); -var ESCAPE = {'n':'\n', 'f':'\f', 'r':'\r', 't':'\t', 'v':'\v', '\'':'\'', '"':'"'}; - - -///////////////////////////////////////// - - -/** - * @constructor - */ -var Lexer = function Lexer(options) { - this.options = options; -}; - -Lexer.prototype = { - constructor: Lexer, - - lex: function(text) { - this.text = text; - this.index = 0; - this.tokens = []; - - while (this.index < this.text.length) { - var ch = this.text.charAt(this.index); - if (ch === '"' || ch === '\'') { - this.readString(ch); - } else if (this.isNumber(ch) || ch === '.' && this.isNumber(this.peek())) { - this.readNumber(); - } else if (this.isIdentifierStart(this.peekMultichar())) { - this.readIdent(); - } else if (this.is(ch, '(){}[].,;:?')) { - this.tokens.push({index: this.index, text: ch}); - this.index++; - } else if (this.isWhitespace(ch)) { - this.index++; - } else { - var ch2 = ch + this.peek(); - var ch3 = ch2 + this.peek(2); - var op1 = OPERATORS[ch]; - var op2 = OPERATORS[ch2]; - var op3 = OPERATORS[ch3]; - if (op1 || op2 || op3) { - var token = op3 ? ch3 : (op2 ? ch2 : ch); - this.tokens.push({index: this.index, text: token, operator: true}); - this.index += token.length; - } else { - this.throwError('Unexpected next character ', this.index, this.index + 1); - } - } - } - return this.tokens; - }, - - is: function(ch, chars) { - return chars.indexOf(ch) !== -1; - }, - - peek: function(i) { - var num = i || 1; - return (this.index + num < this.text.length) ? this.text.charAt(this.index + num) : false; - }, - - isNumber: function(ch) { - return ('0' <= ch && ch <= '9') && typeof ch === 'string'; - }, - - isWhitespace: function(ch) { - // IE treats non-breaking space as \u00A0 - return (ch === ' ' || ch === '\r' || ch === '\t' || - ch === '\n' || ch === '\v' || ch === '\u00A0'); - }, - - isIdentifierStart: function(ch) { - return this.options.isIdentifierStart ? - this.options.isIdentifierStart(ch, this.codePointAt(ch)) : - this.isValidIdentifierStart(ch); - }, - - isValidIdentifierStart: function(ch) { - return ('a' <= ch && ch <= 'z' || - 'A' <= ch && ch <= 'Z' || - '_' === ch || ch === '$'); - }, - - isIdentifierContinue: function(ch) { - return this.options.isIdentifierContinue ? - this.options.isIdentifierContinue(ch, this.codePointAt(ch)) : - this.isValidIdentifierContinue(ch); - }, - - isValidIdentifierContinue: function(ch, cp) { - return this.isValidIdentifierStart(ch, cp) || this.isNumber(ch); - }, - - codePointAt: function(ch) { - if (ch.length === 1) return ch.charCodeAt(0); - // eslint-disable-next-line no-bitwise - return (ch.charCodeAt(0) << 10) + ch.charCodeAt(1) - 0x35FDC00; - }, - - peekMultichar: function() { - var ch = this.text.charAt(this.index); - var peek = this.peek(); - if (!peek) { - return ch; - } - var cp1 = ch.charCodeAt(0); - var cp2 = peek.charCodeAt(0); - if (cp1 >= 0xD800 && cp1 <= 0xDBFF && cp2 >= 0xDC00 && cp2 <= 0xDFFF) { - return ch + peek; - } - return ch; - }, - - isExpOperator: function(ch) { - return (ch === '-' || ch === '+' || this.isNumber(ch)); - }, - - throwError: function(error, start, end) { - end = end || this.index; - var colStr = (isDefined(start) - ? 's ' + start + '-' + this.index + ' [' + this.text.substring(start, end) + ']' - : ' ' + end); - throw $parseMinErr('lexerr', 'Lexer Error: {0} at column{1} in expression [{2}].', - error, colStr, this.text); - }, - - readNumber: function() { - var number = ''; - var start = this.index; - while (this.index < this.text.length) { - var ch = lowercase(this.text.charAt(this.index)); - if (ch === '.' || this.isNumber(ch)) { - number += ch; - } else { - var peekCh = this.peek(); - if (ch === 'e' && this.isExpOperator(peekCh)) { - number += ch; - } else if (this.isExpOperator(ch) && - peekCh && this.isNumber(peekCh) && - number.charAt(number.length - 1) === 'e') { - number += ch; - } else if (this.isExpOperator(ch) && - (!peekCh || !this.isNumber(peekCh)) && - number.charAt(number.length - 1) === 'e') { - this.throwError('Invalid exponent'); - } else { - break; - } - } - this.index++; - } - this.tokens.push({ - index: start, - text: number, - constant: true, - value: Number(number) - }); - }, - - readIdent: function() { - var start = this.index; - this.index += this.peekMultichar().length; - while (this.index < this.text.length) { - var ch = this.peekMultichar(); - if (!this.isIdentifierContinue(ch)) { - break; - } - this.index += ch.length; - } - this.tokens.push({ - index: start, - text: this.text.slice(start, this.index), - identifier: true - }); - }, - - readString: function(quote) { - var start = this.index; - this.index++; - var string = ''; - var rawString = quote; - var escape = false; - while (this.index < this.text.length) { - var ch = this.text.charAt(this.index); - rawString += ch; - if (escape) { - if (ch === 'u') { - var hex = this.text.substring(this.index + 1, this.index + 5); - if (!hex.match(/[\da-f]{4}/i)) { - this.throwError('Invalid unicode escape [\\u' + hex + ']'); - } - this.index += 4; - string += String.fromCharCode(parseInt(hex, 16)); - } else { - var rep = ESCAPE[ch]; - string = string + (rep || ch); - } - escape = false; - } else if (ch === '\\') { - escape = true; - } else if (ch === quote) { - this.index++; - this.tokens.push({ - index: start, - text: rawString, - constant: true, - value: string - }); - return; - } else { - string += ch; - } - this.index++; - } - this.throwError('Unterminated quote', start); - } -}; - -var AST = function AST(lexer, options) { - this.lexer = lexer; - this.options = options; -}; - -AST.Program = 'Program'; -AST.ExpressionStatement = 'ExpressionStatement'; -AST.AssignmentExpression = 'AssignmentExpression'; -AST.ConditionalExpression = 'ConditionalExpression'; -AST.LogicalExpression = 'LogicalExpression'; -AST.BinaryExpression = 'BinaryExpression'; -AST.UnaryExpression = 'UnaryExpression'; -AST.CallExpression = 'CallExpression'; -AST.MemberExpression = 'MemberExpression'; -AST.Identifier = 'Identifier'; -AST.Literal = 'Literal'; -AST.ArrayExpression = 'ArrayExpression'; -AST.Property = 'Property'; -AST.ObjectExpression = 'ObjectExpression'; -AST.ThisExpression = 'ThisExpression'; -AST.LocalsExpression = 'LocalsExpression'; - -// Internal use only -AST.NGValueParameter = 'NGValueParameter'; - -AST.prototype = { - ast: function(text) { - this.text = text; - this.tokens = this.lexer.lex(text); - - var value = this.program(); - - if (this.tokens.length !== 0) { - this.throwError('is an unexpected token', this.tokens[0]); - } - - return value; - }, - - program: function() { - var body = []; - while (true) { - if (this.tokens.length > 0 && !this.peek('}', ')', ';', ']')) - body.push(this.expressionStatement()); - if (!this.expect(';')) { - return { type: AST.Program, body: body}; - } - } - }, - - expressionStatement: function() { - return { type: AST.ExpressionStatement, expression: this.filterChain() }; - }, - - filterChain: function() { - var left = this.expression(); - while (this.expect('|')) { - left = this.filter(left); - } - return left; - }, - - expression: function() { - return this.assignment(); - }, - - assignment: function() { - var result = this.ternary(); - if (this.expect('=')) { - if (!isAssignable(result)) { - throw $parseMinErr('lval', 'Trying to assign a value to a non l-value'); - } - - result = { type: AST.AssignmentExpression, left: result, right: this.assignment(), operator: '='}; - } - return result; - }, - - ternary: function() { - var test = this.logicalOR(); - var alternate; - var consequent; - if (this.expect('?')) { - alternate = this.expression(); - if (this.consume(':')) { - consequent = this.expression(); - return { type: AST.ConditionalExpression, test: test, alternate: alternate, consequent: consequent}; - } - } - return test; - }, - - logicalOR: function() { - var left = this.logicalAND(); - while (this.expect('||')) { - left = { type: AST.LogicalExpression, operator: '||', left: left, right: this.logicalAND() }; - } - return left; - }, - - logicalAND: function() { - var left = this.equality(); - while (this.expect('&&')) { - left = { type: AST.LogicalExpression, operator: '&&', left: left, right: this.equality()}; - } - return left; - }, - - equality: function() { - var left = this.relational(); - var token; - while ((token = this.expect('==','!=','===','!=='))) { - left = { type: AST.BinaryExpression, operator: token.text, left: left, right: this.relational() }; - } - return left; - }, - - relational: function() { - var left = this.additive(); - var token; - while ((token = this.expect('<', '>', '<=', '>='))) { - left = { type: AST.BinaryExpression, operator: token.text, left: left, right: this.additive() }; - } - return left; - }, - - additive: function() { - var left = this.multiplicative(); - var token; - while ((token = this.expect('+','-'))) { - left = { type: AST.BinaryExpression, operator: token.text, left: left, right: this.multiplicative() }; - } - return left; - }, - - multiplicative: function() { - var left = this.unary(); - var token; - while ((token = this.expect('*','/','%'))) { - left = { type: AST.BinaryExpression, operator: token.text, left: left, right: this.unary() }; - } - return left; - }, - - unary: function() { - var token; - if ((token = this.expect('+', '-', '!'))) { - return { type: AST.UnaryExpression, operator: token.text, prefix: true, argument: this.unary() }; - } else { - return this.primary(); - } - }, - - primary: function() { - var primary; - if (this.expect('(')) { - primary = this.filterChain(); - this.consume(')'); - } else if (this.expect('[')) { - primary = this.arrayDeclaration(); - } else if (this.expect('{')) { - primary = this.object(); - } else if (this.selfReferential.hasOwnProperty(this.peek().text)) { - primary = copy(this.selfReferential[this.consume().text]); - } else if (this.options.literals.hasOwnProperty(this.peek().text)) { - primary = { type: AST.Literal, value: this.options.literals[this.consume().text]}; - } else if (this.peek().identifier) { - primary = this.identifier(); - } else if (this.peek().constant) { - primary = this.constant(); - } else { - this.throwError('not a primary expression', this.peek()); - } - - var next; - while ((next = this.expect('(', '[', '.'))) { - if (next.text === '(') { - primary = {type: AST.CallExpression, callee: primary, arguments: this.parseArguments() }; - this.consume(')'); - } else if (next.text === '[') { - primary = { type: AST.MemberExpression, object: primary, property: this.expression(), computed: true }; - this.consume(']'); - } else if (next.text === '.') { - primary = { type: AST.MemberExpression, object: primary, property: this.identifier(), computed: false }; - } else { - this.throwError('IMPOSSIBLE'); - } - } - return primary; - }, - - filter: function(baseExpression) { - var args = [baseExpression]; - var result = {type: AST.CallExpression, callee: this.identifier(), arguments: args, filter: true}; - - while (this.expect(':')) { - args.push(this.expression()); - } - - return result; - }, - - parseArguments: function() { - var args = []; - if (this.peekToken().text !== ')') { - do { - args.push(this.filterChain()); - } while (this.expect(',')); - } - return args; - }, - - identifier: function() { - var token = this.consume(); - if (!token.identifier) { - this.throwError('is not a valid identifier', token); - } - return { type: AST.Identifier, name: token.text }; - }, - - constant: function() { - // TODO check that it is a constant - return { type: AST.Literal, value: this.consume().value }; - }, - - arrayDeclaration: function() { - var elements = []; - if (this.peekToken().text !== ']') { - do { - if (this.peek(']')) { - // Support trailing commas per ES5.1. - break; - } - elements.push(this.expression()); - } while (this.expect(',')); - } - this.consume(']'); - - return { type: AST.ArrayExpression, elements: elements }; - }, - - object: function() { - var properties = [], property; - if (this.peekToken().text !== '}') { - do { - if (this.peek('}')) { - // Support trailing commas per ES5.1. - break; - } - property = {type: AST.Property, kind: 'init'}; - if (this.peek().constant) { - property.key = this.constant(); - property.computed = false; - this.consume(':'); - property.value = this.expression(); - } else if (this.peek().identifier) { - property.key = this.identifier(); - property.computed = false; - if (this.peek(':')) { - this.consume(':'); - property.value = this.expression(); - } else { - property.value = property.key; - } - } else if (this.peek('[')) { - this.consume('['); - property.key = this.expression(); - this.consume(']'); - property.computed = true; - this.consume(':'); - property.value = this.expression(); - } else { - this.throwError('invalid key', this.peek()); - } - properties.push(property); - } while (this.expect(',')); - } - this.consume('}'); - - return {type: AST.ObjectExpression, properties: properties }; - }, - - throwError: function(msg, token) { - throw $parseMinErr('syntax', - 'Syntax Error: Token \'{0}\' {1} at column {2} of the expression [{3}] starting at [{4}].', - token.text, msg, (token.index + 1), this.text, this.text.substring(token.index)); - }, - - consume: function(e1) { - if (this.tokens.length === 0) { - throw $parseMinErr('ueoe', 'Unexpected end of expression: {0}', this.text); - } - - var token = this.expect(e1); - if (!token) { - this.throwError('is unexpected, expecting [' + e1 + ']', this.peek()); - } - return token; - }, - - peekToken: function() { - if (this.tokens.length === 0) { - throw $parseMinErr('ueoe', 'Unexpected end of expression: {0}', this.text); - } - return this.tokens[0]; - }, - - peek: function(e1, e2, e3, e4) { - return this.peekAhead(0, e1, e2, e3, e4); - }, - - peekAhead: function(i, e1, e2, e3, e4) { - if (this.tokens.length > i) { - var token = this.tokens[i]; - var t = token.text; - if (t === e1 || t === e2 || t === e3 || t === e4 || - (!e1 && !e2 && !e3 && !e4)) { - return token; - } - } - return false; - }, - - expect: function(e1, e2, e3, e4) { - var token = this.peek(e1, e2, e3, e4); - if (token) { - this.tokens.shift(); - return token; - } - return false; - }, - - selfReferential: { - 'this': {type: AST.ThisExpression }, - '$locals': {type: AST.LocalsExpression } - } -}; - -function ifDefined(v, d) { - return typeof v !== 'undefined' ? v : d; -} - -function plusFn(l, r) { - if (typeof l === 'undefined') return r; - if (typeof r === 'undefined') return l; - return l + r; -} - -function isStateless($filter, filterName) { - var fn = $filter(filterName); - return !fn.$stateful; -} - -function findConstantAndWatchExpressions(ast, $filter) { - var allConstants; - var argsToWatch; - var isStatelessFilter; - switch (ast.type) { - case AST.Program: - allConstants = true; - forEach(ast.body, function(expr) { - findConstantAndWatchExpressions(expr.expression, $filter); - allConstants = allConstants && expr.expression.constant; - }); - ast.constant = allConstants; - break; - case AST.Literal: - ast.constant = true; - ast.toWatch = []; - break; - case AST.UnaryExpression: - findConstantAndWatchExpressions(ast.argument, $filter); - ast.constant = ast.argument.constant; - ast.toWatch = ast.argument.toWatch; - break; - case AST.BinaryExpression: - findConstantAndWatchExpressions(ast.left, $filter); - findConstantAndWatchExpressions(ast.right, $filter); - ast.constant = ast.left.constant && ast.right.constant; - ast.toWatch = ast.left.toWatch.concat(ast.right.toWatch); - break; - case AST.LogicalExpression: - findConstantAndWatchExpressions(ast.left, $filter); - findConstantAndWatchExpressions(ast.right, $filter); - ast.constant = ast.left.constant && ast.right.constant; - ast.toWatch = ast.constant ? [] : [ast]; - break; - case AST.ConditionalExpression: - findConstantAndWatchExpressions(ast.test, $filter); - findConstantAndWatchExpressions(ast.alternate, $filter); - findConstantAndWatchExpressions(ast.consequent, $filter); - ast.constant = ast.test.constant && ast.alternate.constant && ast.consequent.constant; - ast.toWatch = ast.constant ? [] : [ast]; - break; - case AST.Identifier: - ast.constant = false; - ast.toWatch = [ast]; - break; - case AST.MemberExpression: - findConstantAndWatchExpressions(ast.object, $filter); - if (ast.computed) { - findConstantAndWatchExpressions(ast.property, $filter); - } - ast.constant = ast.object.constant && (!ast.computed || ast.property.constant); - ast.toWatch = [ast]; - break; - case AST.CallExpression: - isStatelessFilter = ast.filter ? isStateless($filter, ast.callee.name) : false; - allConstants = isStatelessFilter; - argsToWatch = []; - forEach(ast.arguments, function(expr) { - findConstantAndWatchExpressions(expr, $filter); - allConstants = allConstants && expr.constant; - if (!expr.constant) { - argsToWatch.push.apply(argsToWatch, expr.toWatch); - } - }); - ast.constant = allConstants; - ast.toWatch = isStatelessFilter ? argsToWatch : [ast]; - break; - case AST.AssignmentExpression: - findConstantAndWatchExpressions(ast.left, $filter); - findConstantAndWatchExpressions(ast.right, $filter); - ast.constant = ast.left.constant && ast.right.constant; - ast.toWatch = [ast]; - break; - case AST.ArrayExpression: - allConstants = true; - argsToWatch = []; - forEach(ast.elements, function(expr) { - findConstantAndWatchExpressions(expr, $filter); - allConstants = allConstants && expr.constant; - if (!expr.constant) { - argsToWatch.push.apply(argsToWatch, expr.toWatch); - } - }); - ast.constant = allConstants; - ast.toWatch = argsToWatch; - break; - case AST.ObjectExpression: - allConstants = true; - argsToWatch = []; - forEach(ast.properties, function(property) { - findConstantAndWatchExpressions(property.value, $filter); - allConstants = allConstants && property.value.constant && !property.computed; - if (!property.value.constant) { - argsToWatch.push.apply(argsToWatch, property.value.toWatch); - } - }); - ast.constant = allConstants; - ast.toWatch = argsToWatch; - break; - case AST.ThisExpression: - ast.constant = false; - ast.toWatch = []; - break; - case AST.LocalsExpression: - ast.constant = false; - ast.toWatch = []; - break; - } -} - -function getInputs(body) { - if (body.length !== 1) return; - var lastExpression = body[0].expression; - var candidate = lastExpression.toWatch; - if (candidate.length !== 1) return candidate; - return candidate[0] !== lastExpression ? candidate : undefined; -} - -function isAssignable(ast) { - return ast.type === AST.Identifier || ast.type === AST.MemberExpression; -} - -function assignableAST(ast) { - if (ast.body.length === 1 && isAssignable(ast.body[0].expression)) { - return {type: AST.AssignmentExpression, left: ast.body[0].expression, right: {type: AST.NGValueParameter}, operator: '='}; - } -} - -function isLiteral(ast) { - return ast.body.length === 0 || - ast.body.length === 1 && ( - ast.body[0].expression.type === AST.Literal || - ast.body[0].expression.type === AST.ArrayExpression || - ast.body[0].expression.type === AST.ObjectExpression); -} - -function isConstant(ast) { - return ast.constant; -} - -function ASTCompiler(astBuilder, $filter) { - this.astBuilder = astBuilder; - this.$filter = $filter; -} - -ASTCompiler.prototype = { - compile: function(expression) { - var self = this; - var ast = this.astBuilder.ast(expression); - this.state = { - nextId: 0, - filters: {}, - fn: {vars: [], body: [], own: {}}, - assign: {vars: [], body: [], own: {}}, - inputs: [] - }; - findConstantAndWatchExpressions(ast, self.$filter); - var extra = ''; - var assignable; - this.stage = 'assign'; - if ((assignable = assignableAST(ast))) { - this.state.computing = 'assign'; - var result = this.nextId(); - this.recurse(assignable, result); - this.return_(result); - extra = 'fn.assign=' + this.generateFunction('assign', 's,v,l'); - } - var toWatch = getInputs(ast.body); - self.stage = 'inputs'; - forEach(toWatch, function(watch, key) { - var fnKey = 'fn' + key; - self.state[fnKey] = {vars: [], body: [], own: {}}; - self.state.computing = fnKey; - var intoId = self.nextId(); - self.recurse(watch, intoId); - self.return_(intoId); - self.state.inputs.push(fnKey); - watch.watchId = key; - }); - this.state.computing = 'fn'; - this.stage = 'main'; - this.recurse(ast); - var fnString = - // The build and minification steps remove the string "use strict" from the code, but this is done using a regex. - // This is a workaround for this until we do a better job at only removing the prefix only when we should. - '"' + this.USE + ' ' + this.STRICT + '";\n' + - this.filterPrefix() + - 'var fn=' + this.generateFunction('fn', 's,l,a,i') + - extra + - this.watchFns() + - 'return fn;'; - - // eslint-disable-next-line no-new-func - var fn = (new Function('$filter', - 'getStringValue', - 'ifDefined', - 'plus', - fnString))( - this.$filter, - getStringValue, - ifDefined, - plusFn); - this.state = this.stage = undefined; - fn.literal = isLiteral(ast); - fn.constant = isConstant(ast); - return fn; - }, - - USE: 'use', - - STRICT: 'strict', - - watchFns: function() { - var result = []; - var fns = this.state.inputs; - var self = this; - forEach(fns, function(name) { - result.push('var ' + name + '=' + self.generateFunction(name, 's')); - }); - if (fns.length) { - result.push('fn.inputs=[' + fns.join(',') + '];'); - } - return result.join(''); - }, - - generateFunction: function(name, params) { - return 'function(' + params + '){' + - this.varsPrefix(name) + - this.body(name) + - '};'; - }, - - filterPrefix: function() { - var parts = []; - var self = this; - forEach(this.state.filters, function(id, filter) { - parts.push(id + '=$filter(' + self.escape(filter) + ')'); - }); - if (parts.length) return 'var ' + parts.join(',') + ';'; - return ''; - }, - - varsPrefix: function(section) { - return this.state[section].vars.length ? 'var ' + this.state[section].vars.join(',') + ';' : ''; - }, - - body: function(section) { - return this.state[section].body.join(''); - }, - - recurse: function(ast, intoId, nameId, recursionFn, create, skipWatchIdCheck) { - var left, right, self = this, args, expression, computed; - recursionFn = recursionFn || noop; - if (!skipWatchIdCheck && isDefined(ast.watchId)) { - intoId = intoId || this.nextId(); - this.if_('i', - this.lazyAssign(intoId, this.computedMember('i', ast.watchId)), - this.lazyRecurse(ast, intoId, nameId, recursionFn, create, true) - ); - return; - } - switch (ast.type) { - case AST.Program: - forEach(ast.body, function(expression, pos) { - self.recurse(expression.expression, undefined, undefined, function(expr) { right = expr; }); - if (pos !== ast.body.length - 1) { - self.current().body.push(right, ';'); - } else { - self.return_(right); - } - }); - break; - case AST.Literal: - expression = this.escape(ast.value); - this.assign(intoId, expression); - recursionFn(intoId || expression); - break; - case AST.UnaryExpression: - this.recurse(ast.argument, undefined, undefined, function(expr) { right = expr; }); - expression = ast.operator + '(' + this.ifDefined(right, 0) + ')'; - this.assign(intoId, expression); - recursionFn(expression); - break; - case AST.BinaryExpression: - this.recurse(ast.left, undefined, undefined, function(expr) { left = expr; }); - this.recurse(ast.right, undefined, undefined, function(expr) { right = expr; }); - if (ast.operator === '+') { - expression = this.plus(left, right); - } else if (ast.operator === '-') { - expression = this.ifDefined(left, 0) + ast.operator + this.ifDefined(right, 0); - } else { - expression = '(' + left + ')' + ast.operator + '(' + right + ')'; - } - this.assign(intoId, expression); - recursionFn(expression); - break; - case AST.LogicalExpression: - intoId = intoId || this.nextId(); - self.recurse(ast.left, intoId); - self.if_(ast.operator === '&&' ? intoId : self.not(intoId), self.lazyRecurse(ast.right, intoId)); - recursionFn(intoId); - break; - case AST.ConditionalExpression: - intoId = intoId || this.nextId(); - self.recurse(ast.test, intoId); - self.if_(intoId, self.lazyRecurse(ast.alternate, intoId), self.lazyRecurse(ast.consequent, intoId)); - recursionFn(intoId); - break; - case AST.Identifier: - intoId = intoId || this.nextId(); - if (nameId) { - nameId.context = self.stage === 'inputs' ? 's' : this.assign(this.nextId(), this.getHasOwnProperty('l', ast.name) + '?l:s'); - nameId.computed = false; - nameId.name = ast.name; - } - self.if_(self.stage === 'inputs' || self.not(self.getHasOwnProperty('l', ast.name)), - function() { - self.if_(self.stage === 'inputs' || 's', function() { - if (create && create !== 1) { - self.if_( - self.isNull(self.nonComputedMember('s', ast.name)), - self.lazyAssign(self.nonComputedMember('s', ast.name), '{}')); - } - self.assign(intoId, self.nonComputedMember('s', ast.name)); - }); - }, intoId && self.lazyAssign(intoId, self.nonComputedMember('l', ast.name)) - ); - recursionFn(intoId); - break; - case AST.MemberExpression: - left = nameId && (nameId.context = this.nextId()) || this.nextId(); - intoId = intoId || this.nextId(); - self.recurse(ast.object, left, undefined, function() { - self.if_(self.notNull(left), function() { - if (ast.computed) { - right = self.nextId(); - self.recurse(ast.property, right); - self.getStringValue(right); - if (create && create !== 1) { - self.if_(self.not(self.computedMember(left, right)), self.lazyAssign(self.computedMember(left, right), '{}')); - } - expression = self.computedMember(left, right); - self.assign(intoId, expression); - if (nameId) { - nameId.computed = true; - nameId.name = right; - } - } else { - if (create && create !== 1) { - self.if_(self.isNull(self.nonComputedMember(left, ast.property.name)), self.lazyAssign(self.nonComputedMember(left, ast.property.name), '{}')); - } - expression = self.nonComputedMember(left, ast.property.name); - self.assign(intoId, expression); - if (nameId) { - nameId.computed = false; - nameId.name = ast.property.name; - } - } - }, function() { - self.assign(intoId, 'undefined'); - }); - recursionFn(intoId); - }, !!create); - break; - case AST.CallExpression: - intoId = intoId || this.nextId(); - if (ast.filter) { - right = self.filter(ast.callee.name); - args = []; - forEach(ast.arguments, function(expr) { - var argument = self.nextId(); - self.recurse(expr, argument); - args.push(argument); - }); - expression = right + '(' + args.join(',') + ')'; - self.assign(intoId, expression); - recursionFn(intoId); - } else { - right = self.nextId(); - left = {}; - args = []; - self.recurse(ast.callee, right, left, function() { - self.if_(self.notNull(right), function() { - forEach(ast.arguments, function(expr) { - self.recurse(expr, ast.constant ? undefined : self.nextId(), undefined, function(argument) { - args.push(argument); - }); - }); - if (left.name) { - expression = self.member(left.context, left.name, left.computed) + '(' + args.join(',') + ')'; - } else { - expression = right + '(' + args.join(',') + ')'; - } - self.assign(intoId, expression); - }, function() { - self.assign(intoId, 'undefined'); - }); - recursionFn(intoId); - }); - } - break; - case AST.AssignmentExpression: - right = this.nextId(); - left = {}; - this.recurse(ast.left, undefined, left, function() { - self.if_(self.notNull(left.context), function() { - self.recurse(ast.right, right); - expression = self.member(left.context, left.name, left.computed) + ast.operator + right; - self.assign(intoId, expression); - recursionFn(intoId || expression); - }); - }, 1); - break; - case AST.ArrayExpression: - args = []; - forEach(ast.elements, function(expr) { - self.recurse(expr, ast.constant ? undefined : self.nextId(), undefined, function(argument) { - args.push(argument); - }); - }); - expression = '[' + args.join(',') + ']'; - this.assign(intoId, expression); - recursionFn(intoId || expression); - break; - case AST.ObjectExpression: - args = []; - computed = false; - forEach(ast.properties, function(property) { - if (property.computed) { - computed = true; - } - }); - if (computed) { - intoId = intoId || this.nextId(); - this.assign(intoId, '{}'); - forEach(ast.properties, function(property) { - if (property.computed) { - left = self.nextId(); - self.recurse(property.key, left); - } else { - left = property.key.type === AST.Identifier ? - property.key.name : - ('' + property.key.value); - } - right = self.nextId(); - self.recurse(property.value, right); - self.assign(self.member(intoId, left, property.computed), right); - }); - } else { - forEach(ast.properties, function(property) { - self.recurse(property.value, ast.constant ? undefined : self.nextId(), undefined, function(expr) { - args.push(self.escape( - property.key.type === AST.Identifier ? property.key.name : - ('' + property.key.value)) + - ':' + expr); - }); - }); - expression = '{' + args.join(',') + '}'; - this.assign(intoId, expression); - } - recursionFn(intoId || expression); - break; - case AST.ThisExpression: - this.assign(intoId, 's'); - recursionFn(intoId || 's'); - break; - case AST.LocalsExpression: - this.assign(intoId, 'l'); - recursionFn(intoId || 'l'); - break; - case AST.NGValueParameter: - this.assign(intoId, 'v'); - recursionFn(intoId || 'v'); - break; - } - }, - - getHasOwnProperty: function(element, property) { - var key = element + '.' + property; - var own = this.current().own; - if (!own.hasOwnProperty(key)) { - own[key] = this.nextId(false, element + '&&(' + this.escape(property) + ' in ' + element + ')'); - } - return own[key]; - }, - - assign: function(id, value) { - if (!id) return; - this.current().body.push(id, '=', value, ';'); - return id; - }, - - filter: function(filterName) { - if (!this.state.filters.hasOwnProperty(filterName)) { - this.state.filters[filterName] = this.nextId(true); - } - return this.state.filters[filterName]; - }, - - ifDefined: function(id, defaultValue) { - return 'ifDefined(' + id + ',' + this.escape(defaultValue) + ')'; - }, - - plus: function(left, right) { - return 'plus(' + left + ',' + right + ')'; - }, - - return_: function(id) { - this.current().body.push('return ', id, ';'); - }, - - if_: function(test, alternate, consequent) { - if (test === true) { - alternate(); - } else { - var body = this.current().body; - body.push('if(', test, '){'); - alternate(); - body.push('}'); - if (consequent) { - body.push('else{'); - consequent(); - body.push('}'); - } - } - }, - - not: function(expression) { - return '!(' + expression + ')'; - }, - - isNull: function(expression) { - return expression + '==null'; - }, - - notNull: function(expression) { - return expression + '!=null'; - }, - - nonComputedMember: function(left, right) { - var SAFE_IDENTIFIER = /^[$_a-zA-Z][$_a-zA-Z0-9]*$/; - var UNSAFE_CHARACTERS = /[^$_a-zA-Z0-9]/g; - if (SAFE_IDENTIFIER.test(right)) { - return left + '.' + right; - } else { - return left + '["' + right.replace(UNSAFE_CHARACTERS, this.stringEscapeFn) + '"]'; - } - }, - - computedMember: function(left, right) { - return left + '[' + right + ']'; - }, - - member: function(left, right, computed) { - if (computed) return this.computedMember(left, right); - return this.nonComputedMember(left, right); - }, - - getStringValue: function(item) { - this.assign(item, 'getStringValue(' + item + ')'); - }, - - lazyRecurse: function(ast, intoId, nameId, recursionFn, create, skipWatchIdCheck) { - var self = this; - return function() { - self.recurse(ast, intoId, nameId, recursionFn, create, skipWatchIdCheck); - }; - }, - - lazyAssign: function(id, value) { - var self = this; - return function() { - self.assign(id, value); - }; - }, - - stringEscapeRegex: /[^ a-zA-Z0-9]/g, - - stringEscapeFn: function(c) { - return '\\u' + ('0000' + c.charCodeAt(0).toString(16)).slice(-4); - }, - - escape: function(value) { - if (isString(value)) return '\'' + value.replace(this.stringEscapeRegex, this.stringEscapeFn) + '\''; - if (isNumber(value)) return value.toString(); - if (value === true) return 'true'; - if (value === false) return 'false'; - if (value === null) return 'null'; - if (typeof value === 'undefined') return 'undefined'; - - throw $parseMinErr('esc', 'IMPOSSIBLE'); - }, - - nextId: function(skip, init) { - var id = 'v' + (this.state.nextId++); - if (!skip) { - this.current().vars.push(id + (init ? '=' + init : '')); - } - return id; - }, - - current: function() { - return this.state[this.state.computing]; - } -}; - - -function ASTInterpreter(astBuilder, $filter) { - this.astBuilder = astBuilder; - this.$filter = $filter; -} - -ASTInterpreter.prototype = { - compile: function(expression) { - var self = this; - var ast = this.astBuilder.ast(expression); - findConstantAndWatchExpressions(ast, self.$filter); - var assignable; - var assign; - if ((assignable = assignableAST(ast))) { - assign = this.recurse(assignable); - } - var toWatch = getInputs(ast.body); - var inputs; - if (toWatch) { - inputs = []; - forEach(toWatch, function(watch, key) { - var input = self.recurse(watch); - watch.input = input; - inputs.push(input); - watch.watchId = key; - }); - } - var expressions = []; - forEach(ast.body, function(expression) { - expressions.push(self.recurse(expression.expression)); - }); - var fn = ast.body.length === 0 ? noop : - ast.body.length === 1 ? expressions[0] : - function(scope, locals) { - var lastValue; - forEach(expressions, function(exp) { - lastValue = exp(scope, locals); - }); - return lastValue; - }; - if (assign) { - fn.assign = function(scope, value, locals) { - return assign(scope, locals, value); - }; - } - if (inputs) { - fn.inputs = inputs; - } - fn.literal = isLiteral(ast); - fn.constant = isConstant(ast); - return fn; - }, - - recurse: function(ast, context, create) { - var left, right, self = this, args; - if (ast.input) { - return this.inputs(ast.input, ast.watchId); - } - switch (ast.type) { - case AST.Literal: - return this.value(ast.value, context); - case AST.UnaryExpression: - right = this.recurse(ast.argument); - return this['unary' + ast.operator](right, context); - case AST.BinaryExpression: - left = this.recurse(ast.left); - right = this.recurse(ast.right); - return this['binary' + ast.operator](left, right, context); - case AST.LogicalExpression: - left = this.recurse(ast.left); - right = this.recurse(ast.right); - return this['binary' + ast.operator](left, right, context); - case AST.ConditionalExpression: - return this['ternary?:']( - this.recurse(ast.test), - this.recurse(ast.alternate), - this.recurse(ast.consequent), - context - ); - case AST.Identifier: - return self.identifier(ast.name, context, create); - case AST.MemberExpression: - left = this.recurse(ast.object, false, !!create); - if (!ast.computed) { - right = ast.property.name; - } - if (ast.computed) right = this.recurse(ast.property); - return ast.computed ? - this.computedMember(left, right, context, create) : - this.nonComputedMember(left, right, context, create); - case AST.CallExpression: - args = []; - forEach(ast.arguments, function(expr) { - args.push(self.recurse(expr)); - }); - if (ast.filter) right = this.$filter(ast.callee.name); - if (!ast.filter) right = this.recurse(ast.callee, true); - return ast.filter ? - function(scope, locals, assign, inputs) { - var values = []; - for (var i = 0; i < args.length; ++i) { - values.push(args[i](scope, locals, assign, inputs)); - } - var value = right.apply(undefined, values, inputs); - return context ? {context: undefined, name: undefined, value: value} : value; - } : - function(scope, locals, assign, inputs) { - var rhs = right(scope, locals, assign, inputs); - var value; - if (rhs.value != null) { - var values = []; - for (var i = 0; i < args.length; ++i) { - values.push(args[i](scope, locals, assign, inputs)); - } - value = rhs.value.apply(rhs.context, values); - } - return context ? {value: value} : value; - }; - case AST.AssignmentExpression: - left = this.recurse(ast.left, true, 1); - right = this.recurse(ast.right); - return function(scope, locals, assign, inputs) { - var lhs = left(scope, locals, assign, inputs); - var rhs = right(scope, locals, assign, inputs); - lhs.context[lhs.name] = rhs; - return context ? {value: rhs} : rhs; - }; - case AST.ArrayExpression: - args = []; - forEach(ast.elements, function(expr) { - args.push(self.recurse(expr)); - }); - return function(scope, locals, assign, inputs) { - var value = []; - for (var i = 0; i < args.length; ++i) { - value.push(args[i](scope, locals, assign, inputs)); - } - return context ? {value: value} : value; - }; - case AST.ObjectExpression: - args = []; - forEach(ast.properties, function(property) { - if (property.computed) { - args.push({key: self.recurse(property.key), - computed: true, - value: self.recurse(property.value) - }); - } else { - args.push({key: property.key.type === AST.Identifier ? - property.key.name : - ('' + property.key.value), - computed: false, - value: self.recurse(property.value) - }); - } - }); - return function(scope, locals, assign, inputs) { - var value = {}; - for (var i = 0; i < args.length; ++i) { - if (args[i].computed) { - value[args[i].key(scope, locals, assign, inputs)] = args[i].value(scope, locals, assign, inputs); - } else { - value[args[i].key] = args[i].value(scope, locals, assign, inputs); - } - } - return context ? {value: value} : value; - }; - case AST.ThisExpression: - return function(scope) { - return context ? {value: scope} : scope; - }; - case AST.LocalsExpression: - return function(scope, locals) { - return context ? {value: locals} : locals; - }; - case AST.NGValueParameter: - return function(scope, locals, assign) { - return context ? {value: assign} : assign; - }; - } - }, - - 'unary+': function(argument, context) { - return function(scope, locals, assign, inputs) { - var arg = argument(scope, locals, assign, inputs); - if (isDefined(arg)) { - arg = +arg; - } else { - arg = 0; - } - return context ? {value: arg} : arg; - }; - }, - 'unary-': function(argument, context) { - return function(scope, locals, assign, inputs) { - var arg = argument(scope, locals, assign, inputs); - if (isDefined(arg)) { - arg = -arg; - } else { - arg = -0; - } - return context ? {value: arg} : arg; - }; - }, - 'unary!': function(argument, context) { - return function(scope, locals, assign, inputs) { - var arg = !argument(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary+': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var lhs = left(scope, locals, assign, inputs); - var rhs = right(scope, locals, assign, inputs); - var arg = plusFn(lhs, rhs); - return context ? {value: arg} : arg; - }; - }, - 'binary-': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var lhs = left(scope, locals, assign, inputs); - var rhs = right(scope, locals, assign, inputs); - var arg = (isDefined(lhs) ? lhs : 0) - (isDefined(rhs) ? rhs : 0); - return context ? {value: arg} : arg; - }; - }, - 'binary*': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) * right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary/': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) / right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary%': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) % right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary===': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) === right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary!==': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) !== right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary==': function(left, right, context) { - return function(scope, locals, assign, inputs) { - // eslint-disable-next-line eqeqeq - var arg = left(scope, locals, assign, inputs) == right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary!=': function(left, right, context) { - return function(scope, locals, assign, inputs) { - // eslint-disable-next-line eqeqeq - var arg = left(scope, locals, assign, inputs) != right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary<': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) < right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary>': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) > right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary<=': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) <= right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary>=': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) >= right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary&&': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) && right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'binary||': function(left, right, context) { - return function(scope, locals, assign, inputs) { - var arg = left(scope, locals, assign, inputs) || right(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - 'ternary?:': function(test, alternate, consequent, context) { - return function(scope, locals, assign, inputs) { - var arg = test(scope, locals, assign, inputs) ? alternate(scope, locals, assign, inputs) : consequent(scope, locals, assign, inputs); - return context ? {value: arg} : arg; - }; - }, - value: function(value, context) { - return function() { return context ? {context: undefined, name: undefined, value: value} : value; }; - }, - identifier: function(name, context, create) { - return function(scope, locals, assign, inputs) { - var base = locals && (name in locals) ? locals : scope; - if (create && create !== 1 && base && base[name] == null) { - base[name] = {}; - } - var value = base ? base[name] : undefined; - if (context) { - return {context: base, name: name, value: value}; - } else { - return value; - } - }; - }, - computedMember: function(left, right, context, create) { - return function(scope, locals, assign, inputs) { - var lhs = left(scope, locals, assign, inputs); - var rhs; - var value; - if (lhs != null) { - rhs = right(scope, locals, assign, inputs); - rhs = getStringValue(rhs); - if (create && create !== 1) { - if (lhs && !(lhs[rhs])) { - lhs[rhs] = {}; - } - } - value = lhs[rhs]; - } - if (context) { - return {context: lhs, name: rhs, value: value}; - } else { - return value; - } - }; - }, - nonComputedMember: function(left, right, context, create) { - return function(scope, locals, assign, inputs) { - var lhs = left(scope, locals, assign, inputs); - if (create && create !== 1) { - if (lhs && lhs[right] == null) { - lhs[right] = {}; - } - } - var value = lhs != null ? lhs[right] : undefined; - if (context) { - return {context: lhs, name: right, value: value}; - } else { - return value; - } - }; - }, - inputs: function(input, watchId) { - return function(scope, value, locals, inputs) { - if (inputs) return inputs[watchId]; - return input(scope, value, locals); - }; - } -}; - -/** - * @constructor - */ -var Parser = function Parser(lexer, $filter, options) { - this.lexer = lexer; - this.$filter = $filter; - this.options = options; - this.ast = new AST(lexer, options); - this.astCompiler = options.csp ? new ASTInterpreter(this.ast, $filter) : - new ASTCompiler(this.ast, $filter); -}; - -Parser.prototype = { - constructor: Parser, - - parse: function(text) { - return this.astCompiler.compile(text); - } -}; - -function getValueOf(value) { - return isFunction(value.valueOf) ? value.valueOf() : objectValueOf.call(value); -} - -/////////////////////////////////// - -/** - * @ngdoc service - * @name $parse - * @kind function - * - * @description - * - * Converts Angular {@link guide/expression expression} into a function. - * - * ```js - * var getter = $parse('user.name'); - * var setter = getter.assign; - * var context = {user:{name:'angular'}}; - * var locals = {user:{name:'local'}}; - * - * expect(getter(context)).toEqual('angular'); - * setter(context, 'newValue'); - * expect(context.user.name).toEqual('newValue'); - * expect(getter(context, locals)).toEqual('local'); - * ``` - * - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - * - * The returned function also has the following properties: - * * `literal` – `{boolean}` – whether the expression's top-level node is a JavaScript - * literal. - * * `constant` – `{boolean}` – whether the expression is made entirely of JavaScript - * constant literals. - * * `assign` – `{?function(context, value)}` – if the expression is assignable, this will be - * set to a function to change its value on the given context. - * - */ - - -/** - * @ngdoc provider - * @name $parseProvider - * @this - * - * @description - * `$parseProvider` can be used for configuring the default behavior of the {@link ng.$parse $parse} - * service. - */ -function $ParseProvider() { - var cache = createMap(); - var literals = { - 'true': true, - 'false': false, - 'null': null, - 'undefined': undefined - }; - var identStart, identContinue; - - /** - * @ngdoc method - * @name $parseProvider#addLiteral - * @description - * - * Configure $parse service to add literal values that will be present as literal at expressions. - * - * @param {string} literalName Token for the literal value. The literal name value must be a valid literal name. - * @param {*} literalValue Value for this literal. All literal values must be primitives or `undefined`. - * - **/ - this.addLiteral = function(literalName, literalValue) { - literals[literalName] = literalValue; - }; - - /** - * @ngdoc method - * @name $parseProvider#setIdentifierFns - * - * @description - * - * Allows defining the set of characters that are allowed in Angular expressions. The function - * `identifierStart` will get called to know if a given character is a valid character to be the - * first character for an identifier. The function `identifierContinue` will get called to know if - * a given character is a valid character to be a follow-up identifier character. The functions - * `identifierStart` and `identifierContinue` will receive as arguments the single character to be - * identifier and the character code point. These arguments will be `string` and `numeric`. Keep in - * mind that the `string` parameter can be two characters long depending on the character - * representation. It is expected for the function to return `true` or `false`, whether that - * character is allowed or not. - * - * Since this function will be called extensively, keep the implementation of these functions fast, - * as the performance of these functions have a direct impact on the expressions parsing speed. - * - * @param {function=} identifierStart The function that will decide whether the given character is - * a valid identifier start character. - * @param {function=} identifierContinue The function that will decide whether the given character is - * a valid identifier continue character. - */ - this.setIdentifierFns = function(identifierStart, identifierContinue) { - identStart = identifierStart; - identContinue = identifierContinue; - return this; - }; - - this.$get = ['$filter', function($filter) { - var noUnsafeEval = csp().noUnsafeEval; - var $parseOptions = { - csp: noUnsafeEval, - literals: copy(literals), - isIdentifierStart: isFunction(identStart) && identStart, - isIdentifierContinue: isFunction(identContinue) && identContinue - }; - return $parse; - - function $parse(exp, interceptorFn) { - var parsedExpression, oneTime, cacheKey; - - switch (typeof exp) { - case 'string': - exp = exp.trim(); - cacheKey = exp; - - parsedExpression = cache[cacheKey]; - - if (!parsedExpression) { - if (exp.charAt(0) === ':' && exp.charAt(1) === ':') { - oneTime = true; - exp = exp.substring(2); - } - var lexer = new Lexer($parseOptions); - var parser = new Parser(lexer, $filter, $parseOptions); - parsedExpression = parser.parse(exp); - if (parsedExpression.constant) { - parsedExpression.$$watchDelegate = constantWatchDelegate; - } else if (oneTime) { - parsedExpression.$$watchDelegate = parsedExpression.literal ? - oneTimeLiteralWatchDelegate : oneTimeWatchDelegate; - } else if (parsedExpression.inputs) { - parsedExpression.$$watchDelegate = inputsWatchDelegate; - } - cache[cacheKey] = parsedExpression; - } - return addInterceptor(parsedExpression, interceptorFn); - - case 'function': - return addInterceptor(exp, interceptorFn); - - default: - return addInterceptor(noop, interceptorFn); - } - } - - function expressionInputDirtyCheck(newValue, oldValueOfValue) { - - if (newValue == null || oldValueOfValue == null) { // null/undefined - return newValue === oldValueOfValue; - } - - if (typeof newValue === 'object') { - - // attempt to convert the value to a primitive type - // TODO(docs): add a note to docs that by implementing valueOf even objects and arrays can - // be cheaply dirty-checked - newValue = getValueOf(newValue); - - if (typeof newValue === 'object') { - // objects/arrays are not supported - deep-watching them would be too expensive - return false; - } - - // fall-through to the primitive equality check - } - - //Primitive or NaN - // eslint-disable-next-line no-self-compare - return newValue === oldValueOfValue || (newValue !== newValue && oldValueOfValue !== oldValueOfValue); - } - - function inputsWatchDelegate(scope, listener, objectEquality, parsedExpression, prettyPrintExpression) { - var inputExpressions = parsedExpression.inputs; - var lastResult; - - if (inputExpressions.length === 1) { - var oldInputValueOf = expressionInputDirtyCheck; // init to something unique so that equals check fails - inputExpressions = inputExpressions[0]; - return scope.$watch(function expressionInputWatch(scope) { - var newInputValue = inputExpressions(scope); - if (!expressionInputDirtyCheck(newInputValue, oldInputValueOf)) { - lastResult = parsedExpression(scope, undefined, undefined, [newInputValue]); - oldInputValueOf = newInputValue && getValueOf(newInputValue); - } - return lastResult; - }, listener, objectEquality, prettyPrintExpression); - } - - var oldInputValueOfValues = []; - var oldInputValues = []; - for (var i = 0, ii = inputExpressions.length; i < ii; i++) { - oldInputValueOfValues[i] = expressionInputDirtyCheck; // init to something unique so that equals check fails - oldInputValues[i] = null; - } - - return scope.$watch(function expressionInputsWatch(scope) { - var changed = false; - - for (var i = 0, ii = inputExpressions.length; i < ii; i++) { - var newInputValue = inputExpressions[i](scope); - if (changed || (changed = !expressionInputDirtyCheck(newInputValue, oldInputValueOfValues[i]))) { - oldInputValues[i] = newInputValue; - oldInputValueOfValues[i] = newInputValue && getValueOf(newInputValue); - } - } - - if (changed) { - lastResult = parsedExpression(scope, undefined, undefined, oldInputValues); - } - - return lastResult; - }, listener, objectEquality, prettyPrintExpression); - } - - function oneTimeWatchDelegate(scope, listener, objectEquality, parsedExpression, prettyPrintExpression) { - var unwatch, lastValue; - if (parsedExpression.inputs) { - unwatch = inputsWatchDelegate(scope, oneTimeListener, objectEquality, parsedExpression, prettyPrintExpression); - } else { - unwatch = scope.$watch(oneTimeWatch, oneTimeListener, objectEquality); - } - return unwatch; - - function oneTimeWatch(scope) { - return parsedExpression(scope); - } - function oneTimeListener(value, old, scope) { - lastValue = value; - if (isFunction(listener)) { - listener(value, old, scope); - } - if (isDefined(value)) { - scope.$$postDigest(function() { - if (isDefined(lastValue)) { - unwatch(); - } - }); - } - } - } - - function oneTimeLiteralWatchDelegate(scope, listener, objectEquality, parsedExpression) { - var unwatch, lastValue; - unwatch = scope.$watch(function oneTimeWatch(scope) { - return parsedExpression(scope); - }, function oneTimeListener(value, old, scope) { - lastValue = value; - if (isFunction(listener)) { - listener(value, old, scope); - } - if (isAllDefined(value)) { - scope.$$postDigest(function() { - if (isAllDefined(lastValue)) unwatch(); - }); - } - }, objectEquality); - - return unwatch; - - function isAllDefined(value) { - var allDefined = true; - forEach(value, function(val) { - if (!isDefined(val)) allDefined = false; - }); - return allDefined; - } - } - - function constantWatchDelegate(scope, listener, objectEquality, parsedExpression) { - var unwatch = scope.$watch(function constantWatch(scope) { - unwatch(); - return parsedExpression(scope); - }, listener, objectEquality); - return unwatch; - } - - function addInterceptor(parsedExpression, interceptorFn) { - if (!interceptorFn) return parsedExpression; - var watchDelegate = parsedExpression.$$watchDelegate; - var useInputs = false; - - var regularWatch = - watchDelegate !== oneTimeLiteralWatchDelegate && - watchDelegate !== oneTimeWatchDelegate; - - var fn = regularWatch ? function regularInterceptedExpression(scope, locals, assign, inputs) { - var value = useInputs && inputs ? inputs[0] : parsedExpression(scope, locals, assign, inputs); - return interceptorFn(value, scope, locals); - } : function oneTimeInterceptedExpression(scope, locals, assign, inputs) { - var value = parsedExpression(scope, locals, assign, inputs); - var result = interceptorFn(value, scope, locals); - // we only return the interceptor's result if the - // initial value is defined (for bind-once) - return isDefined(value) ? result : value; - }; - - // Propagate $$watchDelegates other then inputsWatchDelegate - useInputs = !parsedExpression.inputs; - if (parsedExpression.$$watchDelegate && - parsedExpression.$$watchDelegate !== inputsWatchDelegate) { - fn.$$watchDelegate = parsedExpression.$$watchDelegate; - fn.inputs = parsedExpression.inputs; - } else if (!interceptorFn.$stateful) { - // If there is an interceptor, but no watchDelegate then treat the interceptor like - // we treat filters - it is assumed to be a pure function unless flagged with $stateful - fn.$$watchDelegate = inputsWatchDelegate; - fn.inputs = parsedExpression.inputs ? parsedExpression.inputs : [parsedExpression]; - } - - return fn; - } - }]; -} - -/** - * @ngdoc service - * @name $q - * @requires $rootScope - * - * @description - * A service that helps you run functions asynchronously, and use their return values (or exceptions) - * when they are done processing. - * - * This is a [Promises/A+](https://promisesaplus.com/)-compliant implementation of promises/deferred - * objects inspired by [Kris Kowal's Q](https://github.com/kriskowal/q). - * - * $q can be used in two fashions --- one which is more similar to Kris Kowal's Q or jQuery's Deferred - * implementations, and the other which resembles ES6 (ES2015) promises to some degree. - * - * # $q constructor - * - * The streamlined ES6 style promise is essentially just using $q as a constructor which takes a `resolver` - * function as the first argument. This is similar to the native Promise implementation from ES6, - * see [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). - * - * While the constructor-style use is supported, not all of the supporting methods from ES6 promises are - * available yet. - * - * It can be used like so: - * - * ```js - * // for the purpose of this example let's assume that variables `$q` and `okToGreet` - * // are available in the current lexical scope (they could have been injected or passed in). - * - * function asyncGreet(name) { - * // perform some asynchronous operation, resolve or reject the promise when appropriate. - * return $q(function(resolve, reject) { - * setTimeout(function() { - * if (okToGreet(name)) { - * resolve('Hello, ' + name + '!'); - * } else { - * reject('Greeting ' + name + ' is not allowed.'); - * } - * }, 1000); - * }); - * } - * - * var promise = asyncGreet('Robin Hood'); - * promise.then(function(greeting) { - * alert('Success: ' + greeting); - * }, function(reason) { - * alert('Failed: ' + reason); - * }); - * ``` - * - * Note: progress/notify callbacks are not currently supported via the ES6-style interface. - * - * Note: unlike ES6 behavior, an exception thrown in the constructor function will NOT implicitly reject the promise. - * - * However, the more traditional CommonJS-style usage is still available, and documented below. - * - * [The CommonJS Promise proposal](http://wiki.commonjs.org/wiki/Promises) describes a promise as an - * interface for interacting with an object that represents the result of an action that is - * performed asynchronously, and may or may not be finished at any given point in time. - * - * From the perspective of dealing with error handling, deferred and promise APIs are to - * asynchronous programming what `try`, `catch` and `throw` keywords are to synchronous programming. - * - * ```js - * // for the purpose of this example let's assume that variables `$q` and `okToGreet` - * // are available in the current lexical scope (they could have been injected or passed in). - * - * function asyncGreet(name) { - * var deferred = $q.defer(); - * - * setTimeout(function() { - * deferred.notify('About to greet ' + name + '.'); - * - * if (okToGreet(name)) { - * deferred.resolve('Hello, ' + name + '!'); - * } else { - * deferred.reject('Greeting ' + name + ' is not allowed.'); - * } - * }, 1000); - * - * return deferred.promise; - * } - * - * var promise = asyncGreet('Robin Hood'); - * promise.then(function(greeting) { - * alert('Success: ' + greeting); - * }, function(reason) { - * alert('Failed: ' + reason); - * }, function(update) { - * alert('Got notification: ' + update); - * }); - * ``` - * - * At first it might not be obvious why this extra complexity is worth the trouble. The payoff - * comes in the way of guarantees that promise and deferred APIs make, see - * https://github.com/kriskowal/uncommonjs/blob/master/promises/specification.md. - * - * Additionally the promise api allows for composition that is very hard to do with the - * traditional callback ([CPS](http://en.wikipedia.org/wiki/Continuation-passing_style)) approach. - * For more on this please see the [Q documentation](https://github.com/kriskowal/q) especially the - * section on serial or parallel joining of promises. - * - * # The Deferred API - * - * A new instance of deferred is constructed by calling `$q.defer()`. - * - * The purpose of the deferred object is to expose the associated Promise instance as well as APIs - * that can be used for signaling the successful or unsuccessful completion, as well as the status - * of the task. - * - * **Methods** - * - * - `resolve(value)` – resolves the derived promise with the `value`. If the value is a rejection - * constructed via `$q.reject`, the promise will be rejected instead. - * - `reject(reason)` – rejects the derived promise with the `reason`. This is equivalent to - * resolving it with a rejection constructed via `$q.reject`. - * - `notify(value)` - provides updates on the status of the promise's execution. This may be called - * multiple times before the promise is either resolved or rejected. - * - * **Properties** - * - * - promise – `{Promise}` – promise object associated with this deferred. - * - * - * # The Promise API - * - * A new promise instance is created when a deferred instance is created and can be retrieved by - * calling `deferred.promise`. - * - * The purpose of the promise object is to allow for interested parties to get access to the result - * of the deferred task when it completes. - * - * **Methods** - * - * - `then(successCallback, [errorCallback], [notifyCallback])` – regardless of when the promise was or - * will be resolved or rejected, `then` calls one of the success or error callbacks asynchronously - * as soon as the result is available. The callbacks are called with a single argument: the result - * or rejection reason. Additionally, the notify callback may be called zero or more times to - * provide a progress indication, before the promise is resolved or rejected. - * - * This method *returns a new promise* which is resolved or rejected via the return value of the - * `successCallback`, `errorCallback` (unless that value is a promise, in which case it is resolved - * with the value which is resolved in that promise using - * [promise chaining](http://www.html5rocks.com/en/tutorials/es6/promises/#toc-promises-queues)). - * It also notifies via the return value of the `notifyCallback` method. The promise cannot be - * resolved or rejected from the notifyCallback method. The errorCallback and notifyCallback - * arguments are optional. - * - * - `catch(errorCallback)` – shorthand for `promise.then(null, errorCallback)` - * - * - `finally(callback, notifyCallback)` – allows you to observe either the fulfillment or rejection of a promise, - * but to do so without modifying the final value. This is useful to release resources or do some - * clean-up that needs to be done whether the promise was rejected or resolved. See the [full - * specification](https://github.com/kriskowal/q/wiki/API-Reference#promisefinallycallback) for - * more information. - * - * # Chaining promises - * - * Because calling the `then` method of a promise returns a new derived promise, it is easily - * possible to create a chain of promises: - * - * ```js - * promiseB = promiseA.then(function(result) { - * return result + 1; - * }); - * - * // promiseB will be resolved immediately after promiseA is resolved and its value - * // will be the result of promiseA incremented by 1 - * ``` - * - * It is possible to create chains of any length and since a promise can be resolved with another - * promise (which will defer its resolution further), it is possible to pause/defer resolution of - * the promises at any point in the chain. This makes it possible to implement powerful APIs like - * $http's response interceptors. - * - * - * # Differences between Kris Kowal's Q and $q - * - * There are two main differences: - * - * - $q is integrated with the {@link ng.$rootScope.Scope} Scope model observation - * mechanism in angular, which means faster propagation of resolution or rejection into your - * models and avoiding unnecessary browser repaints, which would result in flickering UI. - * - Q has many more features than $q, but that comes at a cost of bytes. $q is tiny, but contains - * all the important functionality needed for common async tasks. - * - * # Testing - * - * ```js - * it('should simulate promise', inject(function($q, $rootScope) { - * var deferred = $q.defer(); - * var promise = deferred.promise; - * var resolvedValue; - * - * promise.then(function(value) { resolvedValue = value; }); - * expect(resolvedValue).toBeUndefined(); - * - * // Simulate resolving of promise - * deferred.resolve(123); - * // Note that the 'then' function does not get called synchronously. - * // This is because we want the promise API to always be async, whether or not - * // it got called synchronously or asynchronously. - * expect(resolvedValue).toBeUndefined(); - * - * // Propagate promise resolution to 'then' functions using $apply(). - * $rootScope.$apply(); - * expect(resolvedValue).toEqual(123); - * })); - * ``` - * - * @param {function(function, function)} resolver Function which is responsible for resolving or - * rejecting the newly created promise. The first parameter is a function which resolves the - * promise, the second parameter is a function which rejects the promise. - * - * @returns {Promise} The newly created promise. - */ -/** - * @ngdoc provider - * @name $qProvider - * @this - * - * @description - */ -function $QProvider() { - var errorOnUnhandledRejections = true; - this.$get = ['$rootScope', '$exceptionHandler', function($rootScope, $exceptionHandler) { - return qFactory(function(callback) { - $rootScope.$evalAsync(callback); - }, $exceptionHandler, errorOnUnhandledRejections); - }]; - - /** - * @ngdoc method - * @name $qProvider#errorOnUnhandledRejections - * @kind function - * - * @description - * Retrieves or overrides whether to generate an error when a rejected promise is not handled. - * - * @param {boolean=} value Whether to generate an error when a rejected promise is not handled. - * @returns {boolean|ng.$qProvider} Current value when called without a new value or self for - * chaining otherwise. - */ - this.errorOnUnhandledRejections = function(value) { - if (isDefined(value)) { - errorOnUnhandledRejections = value; - return this; - } else { - return errorOnUnhandledRejections; - } - }; -} - -/** @this */ -function $$QProvider() { - var errorOnUnhandledRejections = true; - this.$get = ['$browser', '$exceptionHandler', function($browser, $exceptionHandler) { - return qFactory(function(callback) { - $browser.defer(callback); - }, $exceptionHandler, errorOnUnhandledRejections); - }]; - - this.errorOnUnhandledRejections = function(value) { - if (isDefined(value)) { - errorOnUnhandledRejections = value; - return this; - } else { - return errorOnUnhandledRejections; - } - }; -} - -/** - * Constructs a promise manager. - * - * @param {function(function)} nextTick Function for executing functions in the next turn. - * @param {function(...*)} exceptionHandler Function into which unexpected exceptions are passed for - * debugging purposes. - @ param {=boolean} errorOnUnhandledRejections Whether an error should be generated on unhandled - * promises rejections. - * @returns {object} Promise manager. - */ -function qFactory(nextTick, exceptionHandler, errorOnUnhandledRejections) { - var $qMinErr = minErr('$q', TypeError); - var queueSize = 0; - var checkQueue = []; - - /** - * @ngdoc method - * @name ng.$q#defer - * @kind function - * - * @description - * Creates a `Deferred` object which represents a task which will finish in the future. - * - * @returns {Deferred} Returns a new instance of deferred. - */ - function defer() { - return new Deferred(); - } - - function Deferred() { - var promise = this.promise = new Promise(); - //Non prototype methods necessary to support unbound execution :/ - this.resolve = function(val) { resolvePromise(promise, val); }; - this.reject = function(reason) { rejectPromise(promise, reason); }; - this.notify = function(progress) { notifyPromise(promise, progress); }; - } - - - function Promise() { - this.$$state = { status: 0 }; - } - - extend(Promise.prototype, { - then: function(onFulfilled, onRejected, progressBack) { - if (isUndefined(onFulfilled) && isUndefined(onRejected) && isUndefined(progressBack)) { - return this; - } - var result = new Promise(); - - this.$$state.pending = this.$$state.pending || []; - this.$$state.pending.push([result, onFulfilled, onRejected, progressBack]); - if (this.$$state.status > 0) scheduleProcessQueue(this.$$state); - - return result; - }, - - 'catch': function(callback) { - return this.then(null, callback); - }, - - 'finally': function(callback, progressBack) { - return this.then(function(value) { - return handleCallback(value, resolve, callback); - }, function(error) { - return handleCallback(error, reject, callback); - }, progressBack); - } - }); - - function processQueue(state) { - var fn, promise, pending; - - pending = state.pending; - state.processScheduled = false; - state.pending = undefined; - try { - for (var i = 0, ii = pending.length; i < ii; ++i) { - state.pur = true; - promise = pending[i][0]; - fn = pending[i][state.status]; - try { - if (isFunction(fn)) { - resolvePromise(promise, fn(state.value)); - } else if (state.status === 1) { - resolvePromise(promise, state.value); - } else { - rejectPromise(promise, state.value); - } - } catch (e) { - rejectPromise(promise, e); - } - } - } finally { - --queueSize; - if (errorOnUnhandledRejections && queueSize === 0) { - nextTick(processChecks); - } - } - } - - function processChecks() { - // eslint-disable-next-line no-unmodified-loop-condition - while (!queueSize && checkQueue.length) { - var toCheck = checkQueue.shift(); - if (!toCheck.pur) { - toCheck.pur = true; - var errorMessage = 'Possibly unhandled rejection: ' + toDebugString(toCheck.value); - exceptionHandler(errorMessage); - } - } - } - - function scheduleProcessQueue(state) { - if (errorOnUnhandledRejections && !state.pending && state.status === 2 && !state.pur) { - if (queueSize === 0 && checkQueue.length === 0) { - nextTick(processChecks); - } - checkQueue.push(state); - } - if (state.processScheduled || !state.pending) return; - state.processScheduled = true; - ++queueSize; - nextTick(function() { processQueue(state); }); - } - - function resolvePromise(promise, val) { - if (promise.$$state.status) return; - if (val === promise) { - $$reject(promise, $qMinErr( - 'qcycle', - 'Expected promise to be resolved with value other than itself \'{0}\'', - val)); - } else { - $$resolve(promise, val); - } - - } - - function $$resolve(promise, val) { - var then; - var done = false; - try { - if (isObject(val) || isFunction(val)) then = val.then; - if (isFunction(then)) { - promise.$$state.status = -1; - then.call(val, doResolve, doReject, doNotify); - } else { - promise.$$state.value = val; - promise.$$state.status = 1; - scheduleProcessQueue(promise.$$state); - } - } catch (e) { - doReject(e); - } - - function doResolve(val) { - if (done) return; - done = true; - $$resolve(promise, val); - } - function doReject(val) { - if (done) return; - done = true; - $$reject(promise, val); - } - function doNotify(progress) { - notifyPromise(promise, progress); - } - } - - function rejectPromise(promise, reason) { - if (promise.$$state.status) return; - $$reject(promise, reason); - } - - function $$reject(promise, reason) { - promise.$$state.value = reason; - promise.$$state.status = 2; - scheduleProcessQueue(promise.$$state); - } - - function notifyPromise(promise, progress) { - var callbacks = promise.$$state.pending; - - if ((promise.$$state.status <= 0) && callbacks && callbacks.length) { - nextTick(function() { - var callback, result; - for (var i = 0, ii = callbacks.length; i < ii; i++) { - result = callbacks[i][0]; - callback = callbacks[i][3]; - try { - notifyPromise(result, isFunction(callback) ? callback(progress) : progress); - } catch (e) { - exceptionHandler(e); - } - } - }); - } - } - - /** - * @ngdoc method - * @name $q#reject - * @kind function - * - * @description - * Creates a promise that is resolved as rejected with the specified `reason`. This api should be - * used to forward rejection in a chain of promises. If you are dealing with the last promise in - * a promise chain, you don't need to worry about it. - * - * When comparing deferreds/promises to the familiar behavior of try/catch/throw, think of - * `reject` as the `throw` keyword in JavaScript. This also means that if you "catch" an error via - * a promise error callback and you want to forward the error to the promise derived from the - * current promise, you have to "rethrow" the error by returning a rejection constructed via - * `reject`. - * - * ```js - * promiseB = promiseA.then(function(result) { - * // success: do something and resolve promiseB - * // with the old or a new result - * return result; - * }, function(reason) { - * // error: handle the error if possible and - * // resolve promiseB with newPromiseOrValue, - * // otherwise forward the rejection to promiseB - * if (canHandle(reason)) { - * // handle the error and recover - * return newPromiseOrValue; - * } - * return $q.reject(reason); - * }); - * ``` - * - * @param {*} reason Constant, message, exception or an object representing the rejection reason. - * @returns {Promise} Returns a promise that was already resolved as rejected with the `reason`. - */ - function reject(reason) { - var result = new Promise(); - rejectPromise(result, reason); - return result; - } - - function handleCallback(value, resolver, callback) { - var callbackOutput = null; - try { - if (isFunction(callback)) callbackOutput = callback(); - } catch (e) { - return reject(e); - } - if (isPromiseLike(callbackOutput)) { - return callbackOutput.then(function() { - return resolver(value); - }, reject); - } else { - return resolver(value); - } - } - - /** - * @ngdoc method - * @name $q#when - * @kind function - * - * @description - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. - * This is useful when you are dealing with an object that might or might not be a promise, or if - * the promise comes from a source that can't be trusted. - * - * @param {*} value Value or a promise - * @param {Function=} successCallback - * @param {Function=} errorCallback - * @param {Function=} progressCallback - * @returns {Promise} Returns a promise of the passed value or promise - */ - - - function when(value, callback, errback, progressBack) { - var result = new Promise(); - resolvePromise(result, value); - return result.then(callback, errback, progressBack); - } - - /** - * @ngdoc method - * @name $q#resolve - * @kind function - * - * @description - * Alias of {@link ng.$q#when when} to maintain naming consistency with ES6. - * - * @param {*} value Value or a promise - * @param {Function=} successCallback - * @param {Function=} errorCallback - * @param {Function=} progressCallback - * @returns {Promise} Returns a promise of the passed value or promise - */ - var resolve = when; - - /** - * @ngdoc method - * @name $q#all - * @kind function - * - * @description - * Combines multiple promises into a single promise that is resolved when all of the input - * promises are resolved. - * - * @param {Array.|Object.} promises An array or hash of promises. - * @returns {Promise} Returns a single promise that will be resolved with an array/hash of values, - * each value corresponding to the promise at the same index/key in the `promises` array/hash. - * If any of the promises is resolved with a rejection, this resulting promise will be rejected - * with the same rejection value. - */ - - function all(promises) { - var result = new Promise(), - counter = 0, - results = isArray(promises) ? [] : {}; - - forEach(promises, function(promise, key) { - counter++; - when(promise).then(function(value) { - results[key] = value; - if (!(--counter)) resolvePromise(result, results); - }, function(reason) { - rejectPromise(result, reason); - }); - }); - - if (counter === 0) { - resolvePromise(result, results); - } - - return result; - } - - /** - * @ngdoc method - * @name $q#race - * @kind function - * - * @description - * Returns a promise that resolves or rejects as soon as one of those promises - * resolves or rejects, with the value or reason from that promise. - * - * @param {Array.|Object.} promises An array or hash of promises. - * @returns {Promise} a promise that resolves or rejects as soon as one of the `promises` - * resolves or rejects, with the value or reason from that promise. - */ - - function race(promises) { - var deferred = defer(); - - forEach(promises, function(promise) { - when(promise).then(deferred.resolve, deferred.reject); - }); - - return deferred.promise; - } - - function $Q(resolver) { - if (!isFunction(resolver)) { - throw $qMinErr('norslvr', 'Expected resolverFn, got \'{0}\'', resolver); - } - - var promise = new Promise(); - - function resolveFn(value) { - resolvePromise(promise, value); - } - - function rejectFn(reason) { - rejectPromise(promise, reason); - } - - resolver(resolveFn, rejectFn); - - return promise; - } - - // Let's make the instanceof operator work for promises, so that - // `new $q(fn) instanceof $q` would evaluate to true. - $Q.prototype = Promise.prototype; - - $Q.defer = defer; - $Q.reject = reject; - $Q.when = when; - $Q.resolve = resolve; - $Q.all = all; - $Q.race = race; - - return $Q; -} - -/** @this */ -function $$RAFProvider() { //rAF - this.$get = ['$window', '$timeout', function($window, $timeout) { - var requestAnimationFrame = $window.requestAnimationFrame || - $window.webkitRequestAnimationFrame; - - var cancelAnimationFrame = $window.cancelAnimationFrame || - $window.webkitCancelAnimationFrame || - $window.webkitCancelRequestAnimationFrame; - - var rafSupported = !!requestAnimationFrame; - var raf = rafSupported - ? function(fn) { - var id = requestAnimationFrame(fn); - return function() { - cancelAnimationFrame(id); - }; - } - : function(fn) { - var timer = $timeout(fn, 16.66, false); // 1000 / 60 = 16.666 - return function() { - $timeout.cancel(timer); - }; - }; - - raf.supported = rafSupported; - - return raf; - }]; -} - -/** - * DESIGN NOTES - * - * The design decisions behind the scope are heavily favored for speed and memory consumption. - * - * The typical use of scope is to watch the expressions, which most of the time return the same - * value as last time so we optimize the operation. - * - * Closures construction is expensive in terms of speed as well as memory: - * - No closures, instead use prototypical inheritance for API - * - Internal state needs to be stored on scope directly, which means that private state is - * exposed as $$____ properties - * - * Loop operations are optimized by using while(count--) { ... } - * - This means that in order to keep the same order of execution as addition we have to add - * items to the array at the beginning (unshift) instead of at the end (push) - * - * Child scopes are created and removed often - * - Using an array would be slow since inserts in the middle are expensive; so we use linked lists - * - * There are fewer watches than observers. This is why you don't want the observer to be implemented - * in the same way as watch. Watch requires return of the initialization function which is expensive - * to construct. - */ - - -/** - * @ngdoc provider - * @name $rootScopeProvider - * @description - * - * Provider for the $rootScope service. - */ - -/** - * @ngdoc method - * @name $rootScopeProvider#digestTtl - * @description - * - * Sets the number of `$digest` iterations the scope should attempt to execute before giving up and - * assuming that the model is unstable. - * - * The current default is 10 iterations. - * - * In complex applications it's possible that the dependencies between `$watch`s will result in - * several digest iterations. However if an application needs more than the default 10 digest - * iterations for its model to stabilize then you should investigate what is causing the model to - * continuously change during the digest. - * - * Increasing the TTL could have performance implications, so you should not change it without - * proper justification. - * - * @param {number} limit The number of digest iterations. - */ - - -/** - * @ngdoc service - * @name $rootScope - * @this - * - * @description - * - * Every application has a single root {@link ng.$rootScope.Scope scope}. - * All other scopes are descendant scopes of the root scope. Scopes provide separation - * between the model and the view, via a mechanism for watching the model for changes. - * They also provide event emission/broadcast and subscription facility. See the - * {@link guide/scope developer guide on scopes}. - */ -function $RootScopeProvider() { - var TTL = 10; - var $rootScopeMinErr = minErr('$rootScope'); - var lastDirtyWatch = null; - var applyAsyncId = null; - - this.digestTtl = function(value) { - if (arguments.length) { - TTL = value; - } - return TTL; - }; - - function createChildScopeClass(parent) { - function ChildScope() { - this.$$watchers = this.$$nextSibling = - this.$$childHead = this.$$childTail = null; - this.$$listeners = {}; - this.$$listenerCount = {}; - this.$$watchersCount = 0; - this.$id = nextUid(); - this.$$ChildScope = null; - } - ChildScope.prototype = parent; - return ChildScope; - } - - this.$get = ['$exceptionHandler', '$parse', '$browser', - function($exceptionHandler, $parse, $browser) { - - function destroyChildScope($event) { - $event.currentScope.$$destroyed = true; - } - - function cleanUpScope($scope) { - - // Support: IE 9 only - if (msie === 9) { - // There is a memory leak in IE9 if all child scopes are not disconnected - // completely when a scope is destroyed. So this code will recurse up through - // all this scopes children - // - // See issue https://github.com/angular/angular.js/issues/10706 - if ($scope.$$childHead) { - cleanUpScope($scope.$$childHead); - } - if ($scope.$$nextSibling) { - cleanUpScope($scope.$$nextSibling); - } - } - - // The code below works around IE9 and V8's memory leaks - // - // See: - // - https://code.google.com/p/v8/issues/detail?id=2073#c26 - // - https://github.com/angular/angular.js/issues/6794#issuecomment-38648909 - // - https://github.com/angular/angular.js/issues/1313#issuecomment-10378451 - - $scope.$parent = $scope.$$nextSibling = $scope.$$prevSibling = $scope.$$childHead = - $scope.$$childTail = $scope.$root = $scope.$$watchers = null; - } - - /** - * @ngdoc type - * @name $rootScope.Scope - * - * @description - * A root scope can be retrieved using the {@link ng.$rootScope $rootScope} key from the - * {@link auto.$injector $injector}. Child scopes are created using the - * {@link ng.$rootScope.Scope#$new $new()} method. (Most scopes are created automatically when - * compiled HTML template is executed.) See also the {@link guide/scope Scopes guide} for - * an in-depth introduction and usage examples. - * - * - * # Inheritance - * A scope can inherit from a parent scope, as in this example: - * ```js - var parent = $rootScope; - var child = parent.$new(); - - parent.salutation = "Hello"; - expect(child.salutation).toEqual('Hello'); - - child.salutation = "Welcome"; - expect(child.salutation).toEqual('Welcome'); - expect(parent.salutation).toEqual('Hello'); - * ``` - * - * When interacting with `Scope` in tests, additional helper methods are available on the - * instances of `Scope` type. See {@link ngMock.$rootScope.Scope ngMock Scope} for additional - * details. - * - * - * @param {Object.=} providers Map of service factory which need to be - * provided for the current scope. Defaults to {@link ng}. - * @param {Object.=} instanceCache Provides pre-instantiated services which should - * append/override services provided by `providers`. This is handy - * when unit-testing and having the need to override a default - * service. - * @returns {Object} Newly created scope. - * - */ - function Scope() { - this.$id = nextUid(); - this.$$phase = this.$parent = this.$$watchers = - this.$$nextSibling = this.$$prevSibling = - this.$$childHead = this.$$childTail = null; - this.$root = this; - this.$$destroyed = false; - this.$$listeners = {}; - this.$$listenerCount = {}; - this.$$watchersCount = 0; - this.$$isolateBindings = null; - } - - /** - * @ngdoc property - * @name $rootScope.Scope#$id - * - * @description - * Unique scope ID (monotonically increasing) useful for debugging. - */ - - /** - * @ngdoc property - * @name $rootScope.Scope#$parent - * - * @description - * Reference to the parent scope. - */ - - /** - * @ngdoc property - * @name $rootScope.Scope#$root - * - * @description - * Reference to the root scope. - */ - - Scope.prototype = { - constructor: Scope, - /** - * @ngdoc method - * @name $rootScope.Scope#$new - * @kind function - * - * @description - * Creates a new child {@link ng.$rootScope.Scope scope}. - * - * The parent scope will propagate the {@link ng.$rootScope.Scope#$digest $digest()} event. - * The scope can be removed from the scope hierarchy using {@link ng.$rootScope.Scope#$destroy $destroy()}. - * - * {@link ng.$rootScope.Scope#$destroy $destroy()} must be called on a scope when it is - * desired for the scope and its child scopes to be permanently detached from the parent and - * thus stop participating in model change detection and listener notification by invoking. - * - * @param {boolean} isolate If true, then the scope does not prototypically inherit from the - * parent scope. The scope is isolated, as it can not see parent scope properties. - * When creating widgets, it is useful for the widget to not accidentally read parent - * state. - * - * @param {Scope} [parent=this] The {@link ng.$rootScope.Scope `Scope`} that will be the `$parent` - * of the newly created scope. Defaults to `this` scope if not provided. - * This is used when creating a transclude scope to correctly place it - * in the scope hierarchy while maintaining the correct prototypical - * inheritance. - * - * @returns {Object} The newly created child scope. - * - */ - $new: function(isolate, parent) { - var child; - - parent = parent || this; - - if (isolate) { - child = new Scope(); - child.$root = this.$root; - } else { - // Only create a child scope class if somebody asks for one, - // but cache it to allow the VM to optimize lookups. - if (!this.$$ChildScope) { - this.$$ChildScope = createChildScopeClass(this); - } - child = new this.$$ChildScope(); - } - child.$parent = parent; - child.$$prevSibling = parent.$$childTail; - if (parent.$$childHead) { - parent.$$childTail.$$nextSibling = child; - parent.$$childTail = child; - } else { - parent.$$childHead = parent.$$childTail = child; - } - - // When the new scope is not isolated or we inherit from `this`, and - // the parent scope is destroyed, the property `$$destroyed` is inherited - // prototypically. In all other cases, this property needs to be set - // when the parent scope is destroyed. - // The listener needs to be added after the parent is set - if (isolate || parent !== this) child.$on('$destroy', destroyChildScope); - - return child; - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$watch - * @kind function - * - * @description - * Registers a `listener` callback to be executed whenever the `watchExpression` changes. - * - * - The `watchExpression` is called on every call to {@link ng.$rootScope.Scope#$digest - * $digest()} and should return the value that will be watched. (`watchExpression` should not change - * its value when executed multiple times with the same input because it may be executed multiple - * times by {@link ng.$rootScope.Scope#$digest $digest()}. That is, `watchExpression` should be - * [idempotent](http://en.wikipedia.org/wiki/Idempotence).) - * - The `listener` is called only when the value from the current `watchExpression` and the - * previous call to `watchExpression` are not equal (with the exception of the initial run, - * see below). Inequality is determined according to reference inequality, - * [strict comparison](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators) - * via the `!==` Javascript operator, unless `objectEquality == true` - * (see next point) - * - When `objectEquality == true`, inequality of the `watchExpression` is determined - * according to the {@link angular.equals} function. To save the value of the object for - * later comparison, the {@link angular.copy} function is used. This therefore means that - * watching complex objects will have adverse memory and performance implications. - * - This should not be used to watch for changes in objects that are - * or contain [File](https://developer.mozilla.org/docs/Web/API/File) objects due to limitations with {@link angular.copy `angular.copy`}. - * - The watch `listener` may change the model, which may trigger other `listener`s to fire. - * This is achieved by rerunning the watchers until no changes are detected. The rerun - * iteration limit is 10 to prevent an infinite loop deadlock. - * - * - * If you want to be notified whenever {@link ng.$rootScope.Scope#$digest $digest} is called, - * you can register a `watchExpression` function with no `listener`. (Be prepared for - * multiple calls to your `watchExpression` because it will execute multiple times in a - * single {@link ng.$rootScope.Scope#$digest $digest} cycle if a change is detected.) - * - * After a watcher is registered with the scope, the `listener` fn is called asynchronously - * (via {@link ng.$rootScope.Scope#$evalAsync $evalAsync}) to initialize the - * watcher. In rare cases, this is undesirable because the listener is called when the result - * of `watchExpression` didn't change. To detect this scenario within the `listener` fn, you - * can compare the `newVal` and `oldVal`. If these two values are identical (`===`) then the - * listener was called due to initialization. - * - * - * - * # Example - * ```js - // let's assume that scope was dependency injected as the $rootScope - var scope = $rootScope; - scope.name = 'misko'; - scope.counter = 0; - - expect(scope.counter).toEqual(0); - scope.$watch('name', function(newValue, oldValue) { - scope.counter = scope.counter + 1; - }); - expect(scope.counter).toEqual(0); - - scope.$digest(); - // the listener is always called during the first $digest loop after it was registered - expect(scope.counter).toEqual(1); - - scope.$digest(); - // but now it will not be called unless the value changes - expect(scope.counter).toEqual(1); - - scope.name = 'adam'; - scope.$digest(); - expect(scope.counter).toEqual(2); - - - - // Using a function as a watchExpression - var food; - scope.foodCounter = 0; - expect(scope.foodCounter).toEqual(0); - scope.$watch( - // This function returns the value being watched. It is called for each turn of the $digest loop - function() { return food; }, - // This is the change listener, called when the value returned from the above function changes - function(newValue, oldValue) { - if ( newValue !== oldValue ) { - // Only increment the counter if the value changed - scope.foodCounter = scope.foodCounter + 1; - } - } - ); - // No digest has been run so the counter will be zero - expect(scope.foodCounter).toEqual(0); - - // Run the digest but since food has not changed count will still be zero - scope.$digest(); - expect(scope.foodCounter).toEqual(0); - - // Update food and run digest. Now the counter will increment - food = 'cheeseburger'; - scope.$digest(); - expect(scope.foodCounter).toEqual(1); - - * ``` - * - * - * - * @param {(function()|string)} watchExpression Expression that is evaluated on each - * {@link ng.$rootScope.Scope#$digest $digest} cycle. A change in the return value triggers - * a call to the `listener`. - * - * - `string`: Evaluated as {@link guide/expression expression} - * - `function(scope)`: called with current `scope` as a parameter. - * @param {function(newVal, oldVal, scope)} listener Callback called whenever the value - * of `watchExpression` changes. - * - * - `newVal` contains the current value of the `watchExpression` - * - `oldVal` contains the previous value of the `watchExpression` - * - `scope` refers to the current scope - * @param {boolean=} [objectEquality=false] Compare for object equality using {@link angular.equals} instead of - * comparing for reference equality. - * @returns {function()} Returns a deregistration function for this listener. - */ - $watch: function(watchExp, listener, objectEquality, prettyPrintExpression) { - var get = $parse(watchExp); - - if (get.$$watchDelegate) { - return get.$$watchDelegate(this, listener, objectEquality, get, watchExp); - } - var scope = this, - array = scope.$$watchers, - watcher = { - fn: listener, - last: initWatchVal, - get: get, - exp: prettyPrintExpression || watchExp, - eq: !!objectEquality - }; - - lastDirtyWatch = null; - - if (!isFunction(listener)) { - watcher.fn = noop; - } - - if (!array) { - array = scope.$$watchers = []; - } - // we use unshift since we use a while loop in $digest for speed. - // the while loop reads in reverse order. - array.unshift(watcher); - incrementWatchersCount(this, 1); - - return function deregisterWatch() { - if (arrayRemove(array, watcher) >= 0) { - incrementWatchersCount(scope, -1); - } - lastDirtyWatch = null; - }; - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$watchGroup - * @kind function - * - * @description - * A variant of {@link ng.$rootScope.Scope#$watch $watch()} where it watches an array of `watchExpressions`. - * If any one expression in the collection changes the `listener` is executed. - * - * - The items in the `watchExpressions` array are observed via the standard `$watch` operation. Their return - * values are examined for changes on every call to `$digest`. - * - The `listener` is called whenever any expression in the `watchExpressions` array changes. - * - * @param {Array.} watchExpressions Array of expressions that will be individually - * watched using {@link ng.$rootScope.Scope#$watch $watch()} - * - * @param {function(newValues, oldValues, scope)} listener Callback called whenever the return value of any - * expression in `watchExpressions` changes - * The `newValues` array contains the current values of the `watchExpressions`, with the indexes matching - * those of `watchExpression` - * and the `oldValues` array contains the previous values of the `watchExpressions`, with the indexes matching - * those of `watchExpression` - * The `scope` refers to the current scope. - * @returns {function()} Returns a de-registration function for all listeners. - */ - $watchGroup: function(watchExpressions, listener) { - var oldValues = new Array(watchExpressions.length); - var newValues = new Array(watchExpressions.length); - var deregisterFns = []; - var self = this; - var changeReactionScheduled = false; - var firstRun = true; - - if (!watchExpressions.length) { - // No expressions means we call the listener ASAP - var shouldCall = true; - self.$evalAsync(function() { - if (shouldCall) listener(newValues, newValues, self); - }); - return function deregisterWatchGroup() { - shouldCall = false; - }; - } - - if (watchExpressions.length === 1) { - // Special case size of one - return this.$watch(watchExpressions[0], function watchGroupAction(value, oldValue, scope) { - newValues[0] = value; - oldValues[0] = oldValue; - listener(newValues, (value === oldValue) ? newValues : oldValues, scope); - }); - } - - forEach(watchExpressions, function(expr, i) { - var unwatchFn = self.$watch(expr, function watchGroupSubAction(value, oldValue) { - newValues[i] = value; - oldValues[i] = oldValue; - if (!changeReactionScheduled) { - changeReactionScheduled = true; - self.$evalAsync(watchGroupAction); - } - }); - deregisterFns.push(unwatchFn); - }); - - function watchGroupAction() { - changeReactionScheduled = false; - - if (firstRun) { - firstRun = false; - listener(newValues, newValues, self); - } else { - listener(newValues, oldValues, self); - } - } - - return function deregisterWatchGroup() { - while (deregisterFns.length) { - deregisterFns.shift()(); - } - }; - }, - - - /** - * @ngdoc method - * @name $rootScope.Scope#$watchCollection - * @kind function - * - * @description - * Shallow watches the properties of an object and fires whenever any of the properties change - * (for arrays, this implies watching the array items; for object maps, this implies watching - * the properties). If a change is detected, the `listener` callback is fired. - * - * - The `obj` collection is observed via standard $watch operation and is examined on every - * call to $digest() to see if any items have been added, removed, or moved. - * - The `listener` is called whenever anything within the `obj` has changed. Examples include - * adding, removing, and moving items belonging to an object or array. - * - * - * # Example - * ```js - $scope.names = ['igor', 'matias', 'misko', 'james']; - $scope.dataCount = 4; - - $scope.$watchCollection('names', function(newNames, oldNames) { - $scope.dataCount = newNames.length; - }); - - expect($scope.dataCount).toEqual(4); - $scope.$digest(); - - //still at 4 ... no changes - expect($scope.dataCount).toEqual(4); - - $scope.names.pop(); - $scope.$digest(); - - //now there's been a change - expect($scope.dataCount).toEqual(3); - * ``` - * - * - * @param {string|function(scope)} obj Evaluated as {@link guide/expression expression}. The - * expression value should evaluate to an object or an array which is observed on each - * {@link ng.$rootScope.Scope#$digest $digest} cycle. Any shallow change within the - * collection will trigger a call to the `listener`. - * - * @param {function(newCollection, oldCollection, scope)} listener a callback function called - * when a change is detected. - * - The `newCollection` object is the newly modified data obtained from the `obj` expression - * - The `oldCollection` object is a copy of the former collection data. - * Due to performance considerations, the`oldCollection` value is computed only if the - * `listener` function declares two or more arguments. - * - The `scope` argument refers to the current scope. - * - * @returns {function()} Returns a de-registration function for this listener. When the - * de-registration function is executed, the internal watch operation is terminated. - */ - $watchCollection: function(obj, listener) { - $watchCollectionInterceptor.$stateful = true; - - var self = this; - // the current value, updated on each dirty-check run - var newValue; - // a shallow copy of the newValue from the last dirty-check run, - // updated to match newValue during dirty-check run - var oldValue; - // a shallow copy of the newValue from when the last change happened - var veryOldValue; - // only track veryOldValue if the listener is asking for it - var trackVeryOldValue = (listener.length > 1); - var changeDetected = 0; - var changeDetector = $parse(obj, $watchCollectionInterceptor); - var internalArray = []; - var internalObject = {}; - var initRun = true; - var oldLength = 0; - - function $watchCollectionInterceptor(_value) { - newValue = _value; - var newLength, key, bothNaN, newItem, oldItem; - - // If the new value is undefined, then return undefined as the watch may be a one-time watch - if (isUndefined(newValue)) return; - - if (!isObject(newValue)) { // if primitive - if (oldValue !== newValue) { - oldValue = newValue; - changeDetected++; - } - } else if (isArrayLike(newValue)) { - if (oldValue !== internalArray) { - // we are transitioning from something which was not an array into array. - oldValue = internalArray; - oldLength = oldValue.length = 0; - changeDetected++; - } - - newLength = newValue.length; - - if (oldLength !== newLength) { - // if lengths do not match we need to trigger change notification - changeDetected++; - oldValue.length = oldLength = newLength; - } - // copy the items to oldValue and look for changes. - for (var i = 0; i < newLength; i++) { - oldItem = oldValue[i]; - newItem = newValue[i]; - - // eslint-disable-next-line no-self-compare - bothNaN = (oldItem !== oldItem) && (newItem !== newItem); - if (!bothNaN && (oldItem !== newItem)) { - changeDetected++; - oldValue[i] = newItem; - } - } - } else { - if (oldValue !== internalObject) { - // we are transitioning from something which was not an object into object. - oldValue = internalObject = {}; - oldLength = 0; - changeDetected++; - } - // copy the items to oldValue and look for changes. - newLength = 0; - for (key in newValue) { - if (hasOwnProperty.call(newValue, key)) { - newLength++; - newItem = newValue[key]; - oldItem = oldValue[key]; - - if (key in oldValue) { - // eslint-disable-next-line no-self-compare - bothNaN = (oldItem !== oldItem) && (newItem !== newItem); - if (!bothNaN && (oldItem !== newItem)) { - changeDetected++; - oldValue[key] = newItem; - } - } else { - oldLength++; - oldValue[key] = newItem; - changeDetected++; - } - } - } - if (oldLength > newLength) { - // we used to have more keys, need to find them and destroy them. - changeDetected++; - for (key in oldValue) { - if (!hasOwnProperty.call(newValue, key)) { - oldLength--; - delete oldValue[key]; - } - } - } - } - return changeDetected; - } - - function $watchCollectionAction() { - if (initRun) { - initRun = false; - listener(newValue, newValue, self); - } else { - listener(newValue, veryOldValue, self); - } - - // make a copy for the next time a collection is changed - if (trackVeryOldValue) { - if (!isObject(newValue)) { - //primitive - veryOldValue = newValue; - } else if (isArrayLike(newValue)) { - veryOldValue = new Array(newValue.length); - for (var i = 0; i < newValue.length; i++) { - veryOldValue[i] = newValue[i]; - } - } else { // if object - veryOldValue = {}; - for (var key in newValue) { - if (hasOwnProperty.call(newValue, key)) { - veryOldValue[key] = newValue[key]; - } - } - } - } - } - - return this.$watch(changeDetector, $watchCollectionAction); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$digest - * @kind function - * - * @description - * Processes all of the {@link ng.$rootScope.Scope#$watch watchers} of the current scope and - * its children. Because a {@link ng.$rootScope.Scope#$watch watcher}'s listener can change - * the model, the `$digest()` keeps calling the {@link ng.$rootScope.Scope#$watch watchers} - * until no more listeners are firing. This means that it is possible to get into an infinite - * loop. This function will throw `'Maximum iteration limit exceeded.'` if the number of - * iterations exceeds 10. - * - * Usually, you don't call `$digest()` directly in - * {@link ng.directive:ngController controllers} or in - * {@link ng.$compileProvider#directive directives}. - * Instead, you should call {@link ng.$rootScope.Scope#$apply $apply()} (typically from within - * a {@link ng.$compileProvider#directive directive}), which will force a `$digest()`. - * - * If you want to be notified whenever `$digest()` is called, - * you can register a `watchExpression` function with - * {@link ng.$rootScope.Scope#$watch $watch()} with no `listener`. - * - * In unit tests, you may need to call `$digest()` to simulate the scope life cycle. - * - * # Example - * ```js - var scope = ...; - scope.name = 'misko'; - scope.counter = 0; - - expect(scope.counter).toEqual(0); - scope.$watch('name', function(newValue, oldValue) { - scope.counter = scope.counter + 1; - }); - expect(scope.counter).toEqual(0); - - scope.$digest(); - // the listener is always called during the first $digest loop after it was registered - expect(scope.counter).toEqual(1); - - scope.$digest(); - // but now it will not be called unless the value changes - expect(scope.counter).toEqual(1); - - scope.name = 'adam'; - scope.$digest(); - expect(scope.counter).toEqual(2); - * ``` - * - */ - $digest: function() { - var watch, value, last, fn, get, - watchers, - length, - dirty, ttl = TTL, - next, current, target = this, - watchLog = [], - logIdx, asyncTask; - - beginPhase('$digest'); - // Check for changes to browser url that happened in sync before the call to $digest - $browser.$$checkUrlChange(); - - if (this === $rootScope && applyAsyncId !== null) { - // If this is the root scope, and $applyAsync has scheduled a deferred $apply(), then - // cancel the scheduled $apply and flush the queue of expressions to be evaluated. - $browser.defer.cancel(applyAsyncId); - flushApplyAsync(); - } - - lastDirtyWatch = null; - - do { // "while dirty" loop - dirty = false; - current = target; - - // It's safe for asyncQueuePosition to be a local variable here because this loop can't - // be reentered recursively. Calling $digest from a function passed to $applyAsync would - // lead to a '$digest already in progress' error. - for (var asyncQueuePosition = 0; asyncQueuePosition < asyncQueue.length; asyncQueuePosition++) { - try { - asyncTask = asyncQueue[asyncQueuePosition]; - asyncTask.scope.$eval(asyncTask.expression, asyncTask.locals); - } catch (e) { - $exceptionHandler(e); - } - lastDirtyWatch = null; - } - asyncQueue.length = 0; - - traverseScopesLoop: - do { // "traverse the scopes" loop - if ((watchers = current.$$watchers)) { - // process our watches - length = watchers.length; - while (length--) { - try { - watch = watchers[length]; - // Most common watches are on primitives, in which case we can short - // circuit it with === operator, only when === fails do we use .equals - if (watch) { - get = watch.get; - if ((value = get(current)) !== (last = watch.last) && - !(watch.eq - ? equals(value, last) - : (isNumberNaN(value) && isNumberNaN(last)))) { - dirty = true; - lastDirtyWatch = watch; - watch.last = watch.eq ? copy(value, null) : value; - fn = watch.fn; - fn(value, ((last === initWatchVal) ? value : last), current); - if (ttl < 5) { - logIdx = 4 - ttl; - if (!watchLog[logIdx]) watchLog[logIdx] = []; - watchLog[logIdx].push({ - msg: isFunction(watch.exp) ? 'fn: ' + (watch.exp.name || watch.exp.toString()) : watch.exp, - newVal: value, - oldVal: last - }); - } - } else if (watch === lastDirtyWatch) { - // If the most recently dirty watcher is now clean, short circuit since the remaining watchers - // have already been tested. - dirty = false; - break traverseScopesLoop; - } - } - } catch (e) { - $exceptionHandler(e); - } - } - } - - // Insanity Warning: scope depth-first traversal - // yes, this code is a bit crazy, but it works and we have tests to prove it! - // this piece should be kept in sync with the traversal in $broadcast - if (!(next = ((current.$$watchersCount && current.$$childHead) || - (current !== target && current.$$nextSibling)))) { - while (current !== target && !(next = current.$$nextSibling)) { - current = current.$parent; - } - } - } while ((current = next)); - - // `break traverseScopesLoop;` takes us to here - - if ((dirty || asyncQueue.length) && !(ttl--)) { - clearPhase(); - throw $rootScopeMinErr('infdig', - '{0} $digest() iterations reached. Aborting!\n' + - 'Watchers fired in the last 5 iterations: {1}', - TTL, watchLog); - } - - } while (dirty || asyncQueue.length); - - clearPhase(); - - // postDigestQueuePosition isn't local here because this loop can be reentered recursively. - while (postDigestQueuePosition < postDigestQueue.length) { - try { - postDigestQueue[postDigestQueuePosition++](); - } catch (e) { - $exceptionHandler(e); - } - } - postDigestQueue.length = postDigestQueuePosition = 0; - }, - - - /** - * @ngdoc event - * @name $rootScope.Scope#$destroy - * @eventType broadcast on scope being destroyed - * - * @description - * Broadcasted when a scope and its children are being destroyed. - * - * Note that, in AngularJS, there is also a `$destroy` jQuery event, which can be used to - * clean up DOM bindings before an element is removed from the DOM. - */ - - /** - * @ngdoc method - * @name $rootScope.Scope#$destroy - * @kind function - * - * @description - * Removes the current scope (and all of its children) from the parent scope. Removal implies - * that calls to {@link ng.$rootScope.Scope#$digest $digest()} will no longer - * propagate to the current scope and its children. Removal also implies that the current - * scope is eligible for garbage collection. - * - * The `$destroy()` is usually used by directives such as - * {@link ng.directive:ngRepeat ngRepeat} for managing the - * unrolling of the loop. - * - * Just before a scope is destroyed, a `$destroy` event is broadcasted on this scope. - * Application code can register a `$destroy` event handler that will give it a chance to - * perform any necessary cleanup. - * - * Note that, in AngularJS, there is also a `$destroy` jQuery event, which can be used to - * clean up DOM bindings before an element is removed from the DOM. - */ - $destroy: function() { - // We can't destroy a scope that has been already destroyed. - if (this.$$destroyed) return; - var parent = this.$parent; - - this.$broadcast('$destroy'); - this.$$destroyed = true; - - if (this === $rootScope) { - //Remove handlers attached to window when $rootScope is removed - $browser.$$applicationDestroyed(); - } - - incrementWatchersCount(this, -this.$$watchersCount); - for (var eventName in this.$$listenerCount) { - decrementListenerCount(this, this.$$listenerCount[eventName], eventName); - } - - // sever all the references to parent scopes (after this cleanup, the current scope should - // not be retained by any of our references and should be eligible for garbage collection) - if (parent && parent.$$childHead === this) parent.$$childHead = this.$$nextSibling; - if (parent && parent.$$childTail === this) parent.$$childTail = this.$$prevSibling; - if (this.$$prevSibling) this.$$prevSibling.$$nextSibling = this.$$nextSibling; - if (this.$$nextSibling) this.$$nextSibling.$$prevSibling = this.$$prevSibling; - - // Disable listeners, watchers and apply/digest methods - this.$destroy = this.$digest = this.$apply = this.$evalAsync = this.$applyAsync = noop; - this.$on = this.$watch = this.$watchGroup = function() { return noop; }; - this.$$listeners = {}; - - // Disconnect the next sibling to prevent `cleanUpScope` destroying those too - this.$$nextSibling = null; - cleanUpScope(this); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$eval - * @kind function - * - * @description - * Executes the `expression` on the current scope and returns the result. Any exceptions in - * the expression are propagated (uncaught). This is useful when evaluating Angular - * expressions. - * - * # Example - * ```js - var scope = ng.$rootScope.Scope(); - scope.a = 1; - scope.b = 2; - - expect(scope.$eval('a+b')).toEqual(3); - expect(scope.$eval(function(scope){ return scope.a + scope.b; })).toEqual(3); - * ``` - * - * @param {(string|function())=} expression An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with the current `scope` parameter. - * - * @param {(object)=} locals Local variables object, useful for overriding values in scope. - * @returns {*} The result of evaluating the expression. - */ - $eval: function(expr, locals) { - return $parse(expr)(this, locals); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$evalAsync - * @kind function - * - * @description - * Executes the expression on the current scope at a later point in time. - * - * The `$evalAsync` makes no guarantees as to when the `expression` will be executed, only - * that: - * - * - it will execute after the function that scheduled the evaluation (preferably before DOM - * rendering). - * - at least one {@link ng.$rootScope.Scope#$digest $digest cycle} will be performed after - * `expression` execution. - * - * Any exceptions from the execution of the expression are forwarded to the - * {@link ng.$exceptionHandler $exceptionHandler} service. - * - * __Note:__ if this function is called outside of a `$digest` cycle, a new `$digest` cycle - * will be scheduled. However, it is encouraged to always call code that changes the model - * from within an `$apply` call. That includes code evaluated via `$evalAsync`. - * - * @param {(string|function())=} expression An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with the current `scope` parameter. - * - * @param {(object)=} locals Local variables object, useful for overriding values in scope. - */ - $evalAsync: function(expr, locals) { - // if we are outside of an $digest loop and this is the first time we are scheduling async - // task also schedule async auto-flush - if (!$rootScope.$$phase && !asyncQueue.length) { - $browser.defer(function() { - if (asyncQueue.length) { - $rootScope.$digest(); - } - }); - } - - asyncQueue.push({scope: this, expression: $parse(expr), locals: locals}); - }, - - $$postDigest: function(fn) { - postDigestQueue.push(fn); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$apply - * @kind function - * - * @description - * `$apply()` is used to execute an expression in angular from outside of the angular - * framework. (For example from browser DOM events, setTimeout, XHR or third party libraries). - * Because we are calling into the angular framework we need to perform proper scope life - * cycle of {@link ng.$exceptionHandler exception handling}, - * {@link ng.$rootScope.Scope#$digest executing watches}. - * - * ## Life cycle - * - * # Pseudo-Code of `$apply()` - * ```js - function $apply(expr) { - try { - return $eval(expr); - } catch (e) { - $exceptionHandler(e); - } finally { - $root.$digest(); - } - } - * ``` - * - * - * Scope's `$apply()` method transitions through the following stages: - * - * 1. The {@link guide/expression expression} is executed using the - * {@link ng.$rootScope.Scope#$eval $eval()} method. - * 2. Any exceptions from the execution of the expression are forwarded to the - * {@link ng.$exceptionHandler $exceptionHandler} service. - * 3. The {@link ng.$rootScope.Scope#$watch watch} listeners are fired immediately after the - * expression was executed using the {@link ng.$rootScope.Scope#$digest $digest()} method. - * - * - * @param {(string|function())=} exp An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with current `scope` parameter. - * - * @returns {*} The result of evaluating the expression. - */ - $apply: function(expr) { - try { - beginPhase('$apply'); - try { - return this.$eval(expr); - } finally { - clearPhase(); - } - } catch (e) { - $exceptionHandler(e); - } finally { - try { - $rootScope.$digest(); - } catch (e) { - $exceptionHandler(e); - // eslint-disable-next-line no-unsafe-finally - throw e; - } - } - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$applyAsync - * @kind function - * - * @description - * Schedule the invocation of $apply to occur at a later time. The actual time difference - * varies across browsers, but is typically around ~10 milliseconds. - * - * This can be used to queue up multiple expressions which need to be evaluated in the same - * digest. - * - * @param {(string|function())=} exp An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with current `scope` parameter. - */ - $applyAsync: function(expr) { - var scope = this; - if (expr) { - applyAsyncQueue.push($applyAsyncExpression); - } - expr = $parse(expr); - scheduleApplyAsync(); - - function $applyAsyncExpression() { - scope.$eval(expr); - } - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$on - * @kind function - * - * @description - * Listens on events of a given type. See {@link ng.$rootScope.Scope#$emit $emit} for - * discussion of event life cycle. - * - * The event listener function format is: `function(event, args...)`. The `event` object - * passed into the listener has the following attributes: - * - * - `targetScope` - `{Scope}`: the scope on which the event was `$emit`-ed or - * `$broadcast`-ed. - * - `currentScope` - `{Scope}`: the scope that is currently handling the event. Once the - * event propagates through the scope hierarchy, this property is set to null. - * - `name` - `{string}`: name of the event. - * - `stopPropagation` - `{function=}`: calling `stopPropagation` function will cancel - * further event propagation (available only for events that were `$emit`-ed). - * - `preventDefault` - `{function}`: calling `preventDefault` sets `defaultPrevented` flag - * to true. - * - `defaultPrevented` - `{boolean}`: true if `preventDefault` was called. - * - * @param {string} name Event name to listen on. - * @param {function(event, ...args)} listener Function to call when the event is emitted. - * @returns {function()} Returns a deregistration function for this listener. - */ - $on: function(name, listener) { - var namedListeners = this.$$listeners[name]; - if (!namedListeners) { - this.$$listeners[name] = namedListeners = []; - } - namedListeners.push(listener); - - var current = this; - do { - if (!current.$$listenerCount[name]) { - current.$$listenerCount[name] = 0; - } - current.$$listenerCount[name]++; - } while ((current = current.$parent)); - - var self = this; - return function() { - var indexOfListener = namedListeners.indexOf(listener); - if (indexOfListener !== -1) { - namedListeners[indexOfListener] = null; - decrementListenerCount(self, 1, name); - } - }; - }, - - - /** - * @ngdoc method - * @name $rootScope.Scope#$emit - * @kind function - * - * @description - * Dispatches an event `name` upwards through the scope hierarchy notifying the - * registered {@link ng.$rootScope.Scope#$on} listeners. - * - * The event life cycle starts at the scope on which `$emit` was called. All - * {@link ng.$rootScope.Scope#$on listeners} listening for `name` event on this scope get - * notified. Afterwards, the event traverses upwards toward the root scope and calls all - * registered listeners along the way. The event will stop propagating if one of the listeners - * cancels it. - * - * Any exception emitted from the {@link ng.$rootScope.Scope#$on listeners} will be passed - * onto the {@link ng.$exceptionHandler $exceptionHandler} service. - * - * @param {string} name Event name to emit. - * @param {...*} args Optional one or more arguments which will be passed onto the event listeners. - * @return {Object} Event object (see {@link ng.$rootScope.Scope#$on}). - */ - $emit: function(name, args) { - var empty = [], - namedListeners, - scope = this, - stopPropagation = false, - event = { - name: name, - targetScope: scope, - stopPropagation: function() {stopPropagation = true;}, - preventDefault: function() { - event.defaultPrevented = true; - }, - defaultPrevented: false - }, - listenerArgs = concat([event], arguments, 1), - i, length; - - do { - namedListeners = scope.$$listeners[name] || empty; - event.currentScope = scope; - for (i = 0, length = namedListeners.length; i < length; i++) { - - // if listeners were deregistered, defragment the array - if (!namedListeners[i]) { - namedListeners.splice(i, 1); - i--; - length--; - continue; - } - try { - //allow all listeners attached to the current scope to run - namedListeners[i].apply(null, listenerArgs); - } catch (e) { - $exceptionHandler(e); - } - } - //if any listener on the current scope stops propagation, prevent bubbling - if (stopPropagation) { - event.currentScope = null; - return event; - } - //traverse upwards - scope = scope.$parent; - } while (scope); - - event.currentScope = null; - - return event; - }, - - - /** - * @ngdoc method - * @name $rootScope.Scope#$broadcast - * @kind function - * - * @description - * Dispatches an event `name` downwards to all child scopes (and their children) notifying the - * registered {@link ng.$rootScope.Scope#$on} listeners. - * - * The event life cycle starts at the scope on which `$broadcast` was called. All - * {@link ng.$rootScope.Scope#$on listeners} listening for `name` event on this scope get - * notified. Afterwards, the event propagates to all direct and indirect scopes of the current - * scope and calls all registered listeners along the way. The event cannot be canceled. - * - * Any exception emitted from the {@link ng.$rootScope.Scope#$on listeners} will be passed - * onto the {@link ng.$exceptionHandler $exceptionHandler} service. - * - * @param {string} name Event name to broadcast. - * @param {...*} args Optional one or more arguments which will be passed onto the event listeners. - * @return {Object} Event object, see {@link ng.$rootScope.Scope#$on} - */ - $broadcast: function(name, args) { - var target = this, - current = target, - next = target, - event = { - name: name, - targetScope: target, - preventDefault: function() { - event.defaultPrevented = true; - }, - defaultPrevented: false - }; - - if (!target.$$listenerCount[name]) return event; - - var listenerArgs = concat([event], arguments, 1), - listeners, i, length; - - //down while you can, then up and next sibling or up and next sibling until back at root - while ((current = next)) { - event.currentScope = current; - listeners = current.$$listeners[name] || []; - for (i = 0, length = listeners.length; i < length; i++) { - // if listeners were deregistered, defragment the array - if (!listeners[i]) { - listeners.splice(i, 1); - i--; - length--; - continue; - } - - try { - listeners[i].apply(null, listenerArgs); - } catch (e) { - $exceptionHandler(e); - } - } - - // Insanity Warning: scope depth-first traversal - // yes, this code is a bit crazy, but it works and we have tests to prove it! - // this piece should be kept in sync with the traversal in $digest - // (though it differs due to having the extra check for $$listenerCount) - if (!(next = ((current.$$listenerCount[name] && current.$$childHead) || - (current !== target && current.$$nextSibling)))) { - while (current !== target && !(next = current.$$nextSibling)) { - current = current.$parent; - } - } - } - - event.currentScope = null; - return event; - } - }; - - var $rootScope = new Scope(); - - //The internal queues. Expose them on the $rootScope for debugging/testing purposes. - var asyncQueue = $rootScope.$$asyncQueue = []; - var postDigestQueue = $rootScope.$$postDigestQueue = []; - var applyAsyncQueue = $rootScope.$$applyAsyncQueue = []; - - var postDigestQueuePosition = 0; - - return $rootScope; - - - function beginPhase(phase) { - if ($rootScope.$$phase) { - throw $rootScopeMinErr('inprog', '{0} already in progress', $rootScope.$$phase); - } - - $rootScope.$$phase = phase; - } - - function clearPhase() { - $rootScope.$$phase = null; - } - - function incrementWatchersCount(current, count) { - do { - current.$$watchersCount += count; - } while ((current = current.$parent)); - } - - function decrementListenerCount(current, count, name) { - do { - current.$$listenerCount[name] -= count; - - if (current.$$listenerCount[name] === 0) { - delete current.$$listenerCount[name]; - } - } while ((current = current.$parent)); - } - - /** - * function used as an initial value for watchers. - * because it's unique we can easily tell it apart from other values - */ - function initWatchVal() {} - - function flushApplyAsync() { - while (applyAsyncQueue.length) { - try { - applyAsyncQueue.shift()(); - } catch (e) { - $exceptionHandler(e); - } - } - applyAsyncId = null; - } - - function scheduleApplyAsync() { - if (applyAsyncId === null) { - applyAsyncId = $browser.defer(function() { - $rootScope.$apply(flushApplyAsync); - }); - } - } - }]; -} - -/** - * @ngdoc service - * @name $rootElement - * - * @description - * The root element of Angular application. This is either the element where {@link - * ng.directive:ngApp ngApp} was declared or the element passed into - * {@link angular.bootstrap}. The element represents the root element of application. It is also the - * location where the application's {@link auto.$injector $injector} service gets - * published, and can be retrieved using `$rootElement.injector()`. - */ - - -// the implementation is in angular.bootstrap - -/** - * @this - * @description - * Private service to sanitize uris for links and images. Used by $compile and $sanitize. - */ -function $$SanitizeUriProvider() { - var aHrefSanitizationWhitelist = /^\s*(https?|ftp|mailto|tel|file):/, - imgSrcSanitizationWhitelist = /^\s*((https?|ftp|file|blob):|data:image\/)/; - - /** - * @description - * Retrieves or overrides the default regular expression that is used for whitelisting of safe - * urls during a[href] sanitization. - * - * The sanitization is a security measure aimed at prevent XSS attacks via html links. - * - * Any url about to be assigned to a[href] via data-binding is first normalized and turned into - * an absolute url. Afterwards, the url is matched against the `aHrefSanitizationWhitelist` - * regular expression. If a match is found, the original url is written into the dom. Otherwise, - * the absolute url is prefixed with `'unsafe:'` string and only then is it written into the DOM. - * - * @param {RegExp=} regexp New regexp to whitelist urls with. - * @returns {RegExp|ng.$compileProvider} Current RegExp if called without value or self for - * chaining otherwise. - */ - this.aHrefSanitizationWhitelist = function(regexp) { - if (isDefined(regexp)) { - aHrefSanitizationWhitelist = regexp; - return this; - } - return aHrefSanitizationWhitelist; - }; - - - /** - * @description - * Retrieves or overrides the default regular expression that is used for whitelisting of safe - * urls during img[src] sanitization. - * - * The sanitization is a security measure aimed at prevent XSS attacks via html links. - * - * Any url about to be assigned to img[src] via data-binding is first normalized and turned into - * an absolute url. Afterwards, the url is matched against the `imgSrcSanitizationWhitelist` - * regular expression. If a match is found, the original url is written into the dom. Otherwise, - * the absolute url is prefixed with `'unsafe:'` string and only then is it written into the DOM. - * - * @param {RegExp=} regexp New regexp to whitelist urls with. - * @returns {RegExp|ng.$compileProvider} Current RegExp if called without value or self for - * chaining otherwise. - */ - this.imgSrcSanitizationWhitelist = function(regexp) { - if (isDefined(regexp)) { - imgSrcSanitizationWhitelist = regexp; - return this; - } - return imgSrcSanitizationWhitelist; - }; - - this.$get = function() { - return function sanitizeUri(uri, isImage) { - var regex = isImage ? imgSrcSanitizationWhitelist : aHrefSanitizationWhitelist; - var normalizedVal; - normalizedVal = urlResolve(uri).href; - if (normalizedVal !== '' && !normalizedVal.match(regex)) { - return 'unsafe:' + normalizedVal; - } - return uri; - }; - }; -} - -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - * Any commits to this file should be reviewed with security in mind. * - * Changes to this file can potentially create security vulnerabilities. * - * An approval from 2 Core members with history of modifying * - * this file is required. * - * * - * Does the change somehow allow for arbitrary javascript to be executed? * - * Or allows for someone to change the prototype of built-in objects? * - * Or gives undesired access to variables likes document or window? * - * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -/* exported $SceProvider, $SceDelegateProvider */ - -var $sceMinErr = minErr('$sce'); - -var SCE_CONTEXTS = { - HTML: 'html', - CSS: 'css', - URL: 'url', - // RESOURCE_URL is a subtype of URL used in contexts where a privileged resource is sourced from a - // url. (e.g. ng-include, script src, templateUrl) - RESOURCE_URL: 'resourceUrl', - JS: 'js' -}; - -// Helper functions follow. - -var UNDERSCORE_LOWERCASE_REGEXP = /_([a-z])/g; - -function snakeToCamel(name) { - return name - .replace(UNDERSCORE_LOWERCASE_REGEXP, fnCamelCaseReplace); -} - -function adjustMatcher(matcher) { - if (matcher === 'self') { - return matcher; - } else if (isString(matcher)) { - // Strings match exactly except for 2 wildcards - '*' and '**'. - // '*' matches any character except those from the set ':/.?&'. - // '**' matches any character (like .* in a RegExp). - // More than 2 *'s raises an error as it's ill defined. - if (matcher.indexOf('***') > -1) { - throw $sceMinErr('iwcard', - 'Illegal sequence *** in string matcher. String: {0}', matcher); - } - matcher = escapeForRegexp(matcher). - replace(/\\\*\\\*/g, '.*'). - replace(/\\\*/g, '[^:/.?&;]*'); - return new RegExp('^' + matcher + '$'); - } else if (isRegExp(matcher)) { - // The only other type of matcher allowed is a Regexp. - // Match entire URL / disallow partial matches. - // Flags are reset (i.e. no global, ignoreCase or multiline) - return new RegExp('^' + matcher.source + '$'); - } else { - throw $sceMinErr('imatcher', - 'Matchers may only be "self", string patterns or RegExp objects'); - } -} - - -function adjustMatchers(matchers) { - var adjustedMatchers = []; - if (isDefined(matchers)) { - forEach(matchers, function(matcher) { - adjustedMatchers.push(adjustMatcher(matcher)); - }); - } - return adjustedMatchers; -} - - -/** - * @ngdoc service - * @name $sceDelegate - * @kind function - * - * @description - * - * `$sceDelegate` is a service that is used by the `$sce` service to provide {@link ng.$sce Strict - * Contextual Escaping (SCE)} services to AngularJS. - * - * Typically, you would configure or override the {@link ng.$sceDelegate $sceDelegate} instead of - * the `$sce` service to customize the way Strict Contextual Escaping works in AngularJS. This is - * because, while the `$sce` provides numerous shorthand methods, etc., you really only need to - * override 3 core functions (`trustAs`, `getTrusted` and `valueOf`) to replace the way things - * work because `$sce` delegates to `$sceDelegate` for these operations. - * - * Refer {@link ng.$sceDelegateProvider $sceDelegateProvider} to configure this service. - * - * The default instance of `$sceDelegate` should work out of the box with little pain. While you - * can override it completely to change the behavior of `$sce`, the common case would - * involve configuring the {@link ng.$sceDelegateProvider $sceDelegateProvider} instead by setting - * your own whitelists and blacklists for trusting URLs used for loading AngularJS resources such as - * templates. Refer {@link ng.$sceDelegateProvider#resourceUrlWhitelist - * $sceDelegateProvider.resourceUrlWhitelist} and {@link - * ng.$sceDelegateProvider#resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} - */ - -/** - * @ngdoc provider - * @name $sceDelegateProvider - * @this - * - * @description - * - * The `$sceDelegateProvider` provider allows developers to configure the {@link ng.$sceDelegate - * $sceDelegate} service. This allows one to get/set the whitelists and blacklists used to ensure - * that the URLs used for sourcing Angular templates are safe. Refer {@link - * ng.$sceDelegateProvider#resourceUrlWhitelist $sceDelegateProvider.resourceUrlWhitelist} and - * {@link ng.$sceDelegateProvider#resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} - * - * For the general details about this service in Angular, read the main page for {@link ng.$sce - * Strict Contextual Escaping (SCE)}. - * - * **Example**: Consider the following case. - * - * - your app is hosted at url `http://myapp.example.com/` - * - but some of your templates are hosted on other domains you control such as - * `http://srv01.assets.example.com/`, `http://srv02.assets.example.com/`, etc. - * - and you have an open redirect at `http://myapp.example.com/clickThru?...`. - * - * Here is what a secure configuration for this scenario might look like: - * - * ``` - * angular.module('myApp', []).config(function($sceDelegateProvider) { - * $sceDelegateProvider.resourceUrlWhitelist([ - * // Allow same origin resource loads. - * 'self', - * // Allow loading from our assets domain. Notice the difference between * and **. - * 'http://srv*.assets.example.com/**' - * ]); - * - * // The blacklist overrides the whitelist so the open redirect here is blocked. - * $sceDelegateProvider.resourceUrlBlacklist([ - * 'http://myapp.example.com/clickThru**' - * ]); - * }); - * ``` - */ - -function $SceDelegateProvider() { - this.SCE_CONTEXTS = SCE_CONTEXTS; - - // Resource URLs can also be trusted by policy. - var resourceUrlWhitelist = ['self'], - resourceUrlBlacklist = []; - - /** - * @ngdoc method - * @name $sceDelegateProvider#resourceUrlWhitelist - * @kind function - * - * @param {Array=} whitelist When provided, replaces the resourceUrlWhitelist with the value - * provided. This must be an array or null. A snapshot of this array is used so further - * changes to the array are ignored. - * - * Follow {@link ng.$sce#resourceUrlPatternItem this link} for a description of the items - * allowed in this array. - * - *
- * **Note:** an empty whitelist array will block all URLs! - *
- * - * @return {Array} the currently set whitelist array. - * - * The **default value** when no whitelist has been explicitly set is `['self']` allowing only - * same origin resource requests. - * - * @description - * Sets/Gets the whitelist of trusted resource URLs. - */ - this.resourceUrlWhitelist = function(value) { - if (arguments.length) { - resourceUrlWhitelist = adjustMatchers(value); - } - return resourceUrlWhitelist; - }; - - /** - * @ngdoc method - * @name $sceDelegateProvider#resourceUrlBlacklist - * @kind function - * - * @param {Array=} blacklist When provided, replaces the resourceUrlBlacklist with the value - * provided. This must be an array or null. A snapshot of this array is used so further - * changes to the array are ignored. - * - * Follow {@link ng.$sce#resourceUrlPatternItem this link} for a description of the items - * allowed in this array. - * - * The typical usage for the blacklist is to **block - * [open redirects](http://cwe.mitre.org/data/definitions/601.html)** served by your domain as - * these would otherwise be trusted but actually return content from the redirected domain. - * - * Finally, **the blacklist overrides the whitelist** and has the final say. - * - * @return {Array} the currently set blacklist array. - * - * The **default value** when no whitelist has been explicitly set is the empty array (i.e. there - * is no blacklist.) - * - * @description - * Sets/Gets the blacklist of trusted resource URLs. - */ - - this.resourceUrlBlacklist = function(value) { - if (arguments.length) { - resourceUrlBlacklist = adjustMatchers(value); - } - return resourceUrlBlacklist; - }; - - this.$get = ['$injector', function($injector) { - - var htmlSanitizer = function htmlSanitizer(html) { - throw $sceMinErr('unsafe', 'Attempting to use an unsafe value in a safe context.'); - }; - - if ($injector.has('$sanitize')) { - htmlSanitizer = $injector.get('$sanitize'); - } - - - function matchUrl(matcher, parsedUrl) { - if (matcher === 'self') { - return urlIsSameOrigin(parsedUrl); - } else { - // definitely a regex. See adjustMatchers() - return !!matcher.exec(parsedUrl.href); - } - } - - function isResourceUrlAllowedByPolicy(url) { - var parsedUrl = urlResolve(url.toString()); - var i, n, allowed = false; - // Ensure that at least one item from the whitelist allows this url. - for (i = 0, n = resourceUrlWhitelist.length; i < n; i++) { - if (matchUrl(resourceUrlWhitelist[i], parsedUrl)) { - allowed = true; - break; - } - } - if (allowed) { - // Ensure that no item from the blacklist blocked this url. - for (i = 0, n = resourceUrlBlacklist.length; i < n; i++) { - if (matchUrl(resourceUrlBlacklist[i], parsedUrl)) { - allowed = false; - break; - } - } - } - return allowed; - } - - function generateHolderType(Base) { - var holderType = function TrustedValueHolderType(trustedValue) { - this.$$unwrapTrustedValue = function() { - return trustedValue; - }; - }; - if (Base) { - holderType.prototype = new Base(); - } - holderType.prototype.valueOf = function sceValueOf() { - return this.$$unwrapTrustedValue(); - }; - holderType.prototype.toString = function sceToString() { - return this.$$unwrapTrustedValue().toString(); - }; - return holderType; - } - - var trustedValueHolderBase = generateHolderType(), - byType = {}; - - byType[SCE_CONTEXTS.HTML] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.CSS] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.URL] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.JS] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.RESOURCE_URL] = generateHolderType(byType[SCE_CONTEXTS.URL]); - - /** - * @ngdoc method - * @name $sceDelegate#trustAs - * - * @description - * Returns an object that is trusted by angular for use in specified strict - * contextual escaping contexts (such as ng-bind-html, ng-include, any src - * attribute interpolation, any dom event binding attribute interpolation - * such as for onclick, etc.) that uses the provided value. - * See {@link ng.$sce $sce} for enabling strict contextual escaping. - * - * @param {string} type The kind of context in which this value is safe for use. e.g. url, - * resourceUrl, html, js and css. - * @param {*} value The value that that should be considered trusted/safe. - * @returns {*} A value that can be used to stand in for the provided `value` in places - * where Angular expects a $sce.trustAs() return value. - */ - function trustAs(type, trustedValue) { - var Constructor = (byType.hasOwnProperty(type) ? byType[type] : null); - if (!Constructor) { - throw $sceMinErr('icontext', - 'Attempted to trust a value in invalid context. Context: {0}; Value: {1}', - type, trustedValue); - } - if (trustedValue === null || isUndefined(trustedValue) || trustedValue === '') { - return trustedValue; - } - // All the current contexts in SCE_CONTEXTS happen to be strings. In order to avoid trusting - // mutable objects, we ensure here that the value passed in is actually a string. - if (typeof trustedValue !== 'string') { - throw $sceMinErr('itype', - 'Attempted to trust a non-string value in a content requiring a string: Context: {0}', - type); - } - return new Constructor(trustedValue); - } - - /** - * @ngdoc method - * @name $sceDelegate#valueOf - * - * @description - * If the passed parameter had been returned by a prior call to {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`}, returns the value that had been passed to {@link - * ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}. - * - * If the passed parameter is not a value that had been returned by {@link - * ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}, returns it as-is. - * - * @param {*} value The result of a prior {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`} - * call or anything else. - * @returns {*} The `value` that was originally provided to {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`} if `value` is the result of such a call. Otherwise, returns - * `value` unchanged. - */ - function valueOf(maybeTrusted) { - if (maybeTrusted instanceof trustedValueHolderBase) { - return maybeTrusted.$$unwrapTrustedValue(); - } else { - return maybeTrusted; - } - } - - /** - * @ngdoc method - * @name $sceDelegate#getTrusted - * - * @description - * Takes the result of a {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`} call and - * returns the originally supplied value if the queried context type is a supertype of the - * created type. If this condition isn't satisfied, throws an exception. - * - *
- * Disabling auto-escaping is extremely dangerous, it usually creates a Cross Site Scripting - * (XSS) vulnerability in your application. - *
- * - * @param {string} type The kind of context in which this value is to be used. - * @param {*} maybeTrusted The result of a prior {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`} call. - * @returns {*} The value the was originally provided to {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`} if valid in this context. Otherwise, throws an exception. - */ - function getTrusted(type, maybeTrusted) { - if (maybeTrusted === null || isUndefined(maybeTrusted) || maybeTrusted === '') { - return maybeTrusted; - } - var constructor = (byType.hasOwnProperty(type) ? byType[type] : null); - if (constructor && maybeTrusted instanceof constructor) { - return maybeTrusted.$$unwrapTrustedValue(); - } - // If we get here, then we may only take one of two actions. - // 1. sanitize the value for the requested type, or - // 2. throw an exception. - if (type === SCE_CONTEXTS.RESOURCE_URL) { - if (isResourceUrlAllowedByPolicy(maybeTrusted)) { - return maybeTrusted; - } else { - throw $sceMinErr('insecurl', - 'Blocked loading resource from url not allowed by $sceDelegate policy. URL: {0}', - maybeTrusted.toString()); - } - } else if (type === SCE_CONTEXTS.HTML) { - return htmlSanitizer(maybeTrusted); - } - throw $sceMinErr('unsafe', 'Attempting to use an unsafe value in a safe context.'); - } - - return { trustAs: trustAs, - getTrusted: getTrusted, - valueOf: valueOf }; - }]; -} - - -/** - * @ngdoc provider - * @name $sceProvider - * @this - * - * @description - * - * The $sceProvider provider allows developers to configure the {@link ng.$sce $sce} service. - * - enable/disable Strict Contextual Escaping (SCE) in a module - * - override the default implementation with a custom delegate - * - * Read more about {@link ng.$sce Strict Contextual Escaping (SCE)}. - */ - -/** - * @ngdoc service - * @name $sce - * @kind function - * - * @description - * - * `$sce` is a service that provides Strict Contextual Escaping services to AngularJS. - * - * # Strict Contextual Escaping - * - * Strict Contextual Escaping (SCE) is a mode in which AngularJS requires bindings in certain - * contexts to result in a value that is marked as safe to use for that context. One example of - * such a context is binding arbitrary html controlled by the user via `ng-bind-html`. We refer - * to these contexts as privileged or SCE contexts. - * - * As of version 1.2, Angular ships with SCE enabled by default. - * - * Note: When enabled (the default), IE<11 in quirks mode is not supported. In this mode, IE<11 allow - * one to execute arbitrary javascript by the use of the expression() syntax. Refer - * to learn more about them. - * You can ensure your document is in standards mode and not quirks mode by adding `` - * to the top of your HTML document. - * - * SCE assists in writing code in a way that (a) is secure by default and (b) makes auditing for - * security vulnerabilities such as XSS, clickjacking, etc. a lot easier. - * - * Here's an example of a binding in a privileged context: - * - * ``` - * - *
- * ``` - * - * Notice that `ng-bind-html` is bound to `userHtml` controlled by the user. With SCE - * disabled, this application allows the user to render arbitrary HTML into the DIV. - * In a more realistic example, one may be rendering user comments, blog articles, etc. via - * bindings. (HTML is just one example of a context where rendering user controlled input creates - * security vulnerabilities.) - * - * For the case of HTML, you might use a library, either on the client side, or on the server side, - * to sanitize unsafe HTML before binding to the value and rendering it in the document. - * - * How would you ensure that every place that used these types of bindings was bound to a value that - * was sanitized by your library (or returned as safe for rendering by your server?) How can you - * ensure that you didn't accidentally delete the line that sanitized the value, or renamed some - * properties/fields and forgot to update the binding to the sanitized value? - * - * To be secure by default, you want to ensure that any such bindings are disallowed unless you can - * determine that something explicitly says it's safe to use a value for binding in that - * context. You can then audit your code (a simple grep would do) to ensure that this is only done - * for those values that you can easily tell are safe - because they were received from your server, - * sanitized by your library, etc. You can organize your codebase to help with this - perhaps - * allowing only the files in a specific directory to do this. Ensuring that the internal API - * exposed by that code doesn't markup arbitrary values as safe then becomes a more manageable task. - * - * In the case of AngularJS' SCE service, one uses {@link ng.$sce#trustAs $sce.trustAs} - * (and shorthand methods such as {@link ng.$sce#trustAsHtml $sce.trustAsHtml}, etc.) to - * obtain values that will be accepted by SCE / privileged contexts. - * - * - * ## How does it work? - * - * In privileged contexts, directives and code will bind to the result of {@link ng.$sce#getTrusted - * $sce.getTrusted(context, value)} rather than to the value directly. Directives use {@link - * ng.$sce#parseAs $sce.parseAs} rather than `$parse` to watch attribute bindings, which performs the - * {@link ng.$sce#getTrusted $sce.getTrusted} behind the scenes on non-constant literals. - * - * As an example, {@link ng.directive:ngBindHtml ngBindHtml} uses {@link - * ng.$sce#parseAsHtml $sce.parseAsHtml(binding expression)}. Here's the actual code (slightly - * simplified): - * - * ``` - * var ngBindHtmlDirective = ['$sce', function($sce) { - * return function(scope, element, attr) { - * scope.$watch($sce.parseAsHtml(attr.ngBindHtml), function(value) { - * element.html(value || ''); - * }); - * }; - * }]; - * ``` - * - * ## Impact on loading templates - * - * This applies both to the {@link ng.directive:ngInclude `ng-include`} directive as well as - * `templateUrl`'s specified by {@link guide/directive directives}. - * - * By default, Angular only loads templates from the same domain and protocol as the application - * document. This is done by calling {@link ng.$sce#getTrustedResourceUrl - * $sce.getTrustedResourceUrl} on the template URL. To load templates from other domains and/or - * protocols, you may either {@link ng.$sceDelegateProvider#resourceUrlWhitelist whitelist - * them} or {@link ng.$sce#trustAsResourceUrl wrap it} into a trusted value. - * - * *Please note*: - * The browser's - * [Same Origin Policy](https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest) - * and [Cross-Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/) - * policy apply in addition to this and may further restrict whether the template is successfully - * loaded. This means that without the right CORS policy, loading templates from a different domain - * won't work on all browsers. Also, loading templates from `file://` URL does not work on some - * browsers. - * - * ## This feels like too much overhead - * - * It's important to remember that SCE only applies to interpolation expressions. - * - * If your expressions are constant literals, they're automatically trusted and you don't need to - * call `$sce.trustAs` on them (remember to include the `ngSanitize` module) (e.g. - * `
`) just works. - * - * Additionally, `a[href]` and `img[src]` automatically sanitize their URLs and do not pass them - * through {@link ng.$sce#getTrusted $sce.getTrusted}. SCE doesn't play a role here. - * - * The included {@link ng.$sceDelegate $sceDelegate} comes with sane defaults to allow you to load - * templates in `ng-include` from your application's domain without having to even know about SCE. - * It blocks loading templates from other domains or loading templates over http from an https - * served document. You can change these by setting your own custom {@link - * ng.$sceDelegateProvider#resourceUrlWhitelist whitelists} and {@link - * ng.$sceDelegateProvider#resourceUrlBlacklist blacklists} for matching such URLs. - * - * This significantly reduces the overhead. It is far easier to pay the small overhead and have an - * application that's secure and can be audited to verify that with much more ease than bolting - * security onto an application later. - * - * - * ## What trusted context types are supported? - * - * | Context | Notes | - * |---------------------|----------------| - * | `$sce.HTML` | For HTML that's safe to source into the application. The {@link ng.directive:ngBindHtml ngBindHtml} directive uses this context for bindings. If an unsafe value is encountered and the {@link ngSanitize $sanitize} module is present this will sanitize the value instead of throwing an error. | - * | `$sce.CSS` | For CSS that's safe to source into the application. Currently unused. Feel free to use it in your own directives. | - * | `$sce.URL` | For URLs that are safe to follow as links. Currently unused (`
Note that `$sce.RESOURCE_URL` makes a stronger statement about the URL than `$sce.URL` does and therefore contexts requiring values trusted for `$sce.RESOURCE_URL` can be used anywhere that values trusted for `$sce.URL` are required. | - * | `$sce.JS` | For JavaScript that is safe to execute in your application's context. Currently unused. Feel free to use it in your own directives. | - * - * ## Format of items in {@link ng.$sceDelegateProvider#resourceUrlWhitelist resourceUrlWhitelist}/{@link ng.$sceDelegateProvider#resourceUrlBlacklist Blacklist} - * - * Each element in these arrays must be one of the following: - * - * - **'self'** - * - The special **string**, `'self'`, can be used to match against all URLs of the **same - * domain** as the application document using the **same protocol**. - * - **String** (except the special value `'self'`) - * - The string is matched against the full *normalized / absolute URL* of the resource - * being tested (substring matches are not good enough.) - * - There are exactly **two wildcard sequences** - `*` and `**`. All other characters - * match themselves. - * - `*`: matches zero or more occurrences of any character other than one of the following 6 - * characters: '`:`', '`/`', '`.`', '`?`', '`&`' and '`;`'. It's a useful wildcard for use - * in a whitelist. - * - `**`: matches zero or more occurrences of *any* character. As such, it's not - * appropriate for use in a scheme, domain, etc. as it would match too much. (e.g. - * http://**.example.com/ would match http://evil.com/?ignore=.example.com/ and that might - * not have been the intention.) Its usage at the very end of the path is ok. (e.g. - * http://foo.example.com/templates/**). - * - **RegExp** (*see caveat below*) - * - *Caveat*: While regular expressions are powerful and offer great flexibility, their syntax - * (and all the inevitable escaping) makes them *harder to maintain*. It's easy to - * accidentally introduce a bug when one updates a complex expression (imho, all regexes should - * have good test coverage). For instance, the use of `.` in the regex is correct only in a - * small number of cases. A `.` character in the regex used when matching the scheme or a - * subdomain could be matched against a `:` or literal `.` that was likely not intended. It - * is highly recommended to use the string patterns and only fall back to regular expressions - * as a last resort. - * - The regular expression must be an instance of RegExp (i.e. not a string.) It is - * matched against the **entire** *normalized / absolute URL* of the resource being tested - * (even when the RegExp did not have the `^` and `$` codes.) In addition, any flags - * present on the RegExp (such as multiline, global, ignoreCase) are ignored. - * - If you are generating your JavaScript from some other templating engine (not - * recommended, e.g. in issue [#4006](https://github.com/angular/angular.js/issues/4006)), - * remember to escape your regular expression (and be aware that you might need more than - * one level of escaping depending on your templating engine and the way you interpolated - * the value.) Do make use of your platform's escaping mechanism as it might be good - * enough before coding your own. E.g. Ruby has - * [Regexp.escape(str)](http://www.ruby-doc.org/core-2.0.0/Regexp.html#method-c-escape) - * and Python has [re.escape](http://docs.python.org/library/re.html#re.escape). - * Javascript lacks a similar built in function for escaping. Take a look at Google - * Closure library's [goog.string.regExpEscape(s)]( - * http://docs.closure-library.googlecode.com/git/closure_goog_string_string.js.source.html#line962). - * - * Refer {@link ng.$sceDelegateProvider $sceDelegateProvider} for an example. - * - * ## Show me an example using SCE. - * - * - * - *
- *

- * User comments
- * By default, HTML that isn't explicitly trusted (e.g. Alice's comment) is sanitized when - * $sanitize is available. If $sanitize isn't available, this results in an error instead of an - * exploit. - *
- *
- * {{userComment.name}}: - * - *
- *
- *
- *
- * - * - * - * angular.module('mySceApp', ['ngSanitize']) - * .controller('AppController', ['$http', '$templateCache', '$sce', - * function AppController($http, $templateCache, $sce) { - * var self = this; - * $http.get('test_data.json', {cache: $templateCache}).then(function(response) { - * self.userComments = response.data; - * }); - * self.explicitlyTrustedHtml = $sce.trustAsHtml( - * 'Hover over this text.'); - * }]); - * - * - * - * [ - * { "name": "Alice", - * "htmlComment": - * "Is anyone reading this?" - * }, - * { "name": "Bob", - * "htmlComment": "Yes! Am I the only other one?" - * } - * ] - * - * - * - * describe('SCE doc demo', function() { - * it('should sanitize untrusted values', function() { - * expect(element.all(by.css('.htmlComment')).first().getAttribute('innerHTML')) - * .toBe('Is anyone reading this?'); - * }); - * - * it('should NOT sanitize explicitly trusted values', function() { - * expect(element(by.id('explicitlyTrustedHtml')).getAttribute('innerHTML')).toBe( - * 'Hover over this text.'); - * }); - * }); - * - * - * - * - * - * ## Can I disable SCE completely? - * - * Yes, you can. However, this is strongly discouraged. SCE gives you a lot of security benefits - * for little coding overhead. It will be much harder to take an SCE disabled application and - * either secure it on your own or enable SCE at a later stage. It might make sense to disable SCE - * for cases where you have a lot of existing code that was written before SCE was introduced and - * you're migrating them a module at a time. - * - * That said, here's how you can completely disable SCE: - * - * ``` - * angular.module('myAppWithSceDisabledmyApp', []).config(function($sceProvider) { - * // Completely disable SCE. For demonstration purposes only! - * // Do not use in new projects. - * $sceProvider.enabled(false); - * }); - * ``` - * - */ - -function $SceProvider() { - var enabled = true; - - /** - * @ngdoc method - * @name $sceProvider#enabled - * @kind function - * - * @param {boolean=} value If provided, then enables/disables SCE. - * @return {boolean} true if SCE is enabled, false otherwise. - * - * @description - * Enables/disables SCE and returns the current value. - */ - this.enabled = function(value) { - if (arguments.length) { - enabled = !!value; - } - return enabled; - }; - - - /* Design notes on the default implementation for SCE. - * - * The API contract for the SCE delegate - * ------------------------------------- - * The SCE delegate object must provide the following 3 methods: - * - * - trustAs(contextEnum, value) - * This method is used to tell the SCE service that the provided value is OK to use in the - * contexts specified by contextEnum. It must return an object that will be accepted by - * getTrusted() for a compatible contextEnum and return this value. - * - * - valueOf(value) - * For values that were not produced by trustAs(), return them as is. For values that were - * produced by trustAs(), return the corresponding input value to trustAs. Basically, if - * trustAs is wrapping the given values into some type, this operation unwraps it when given - * such a value. - * - * - getTrusted(contextEnum, value) - * This function should return the a value that is safe to use in the context specified by - * contextEnum or throw and exception otherwise. - * - * NOTE: This contract deliberately does NOT state that values returned by trustAs() must be - * opaque or wrapped in some holder object. That happens to be an implementation detail. For - * instance, an implementation could maintain a registry of all trusted objects by context. In - * such a case, trustAs() would return the same object that was passed in. getTrusted() would - * return the same object passed in if it was found in the registry under a compatible context or - * throw an exception otherwise. An implementation might only wrap values some of the time based - * on some criteria. getTrusted() might return a value and not throw an exception for special - * constants or objects even if not wrapped. All such implementations fulfill this contract. - * - * - * A note on the inheritance model for SCE contexts - * ------------------------------------------------ - * I've used inheritance and made RESOURCE_URL wrapped types a subtype of URL wrapped types. This - * is purely an implementation details. - * - * The contract is simply this: - * - * getTrusted($sce.RESOURCE_URL, value) succeeding implies that getTrusted($sce.URL, value) - * will also succeed. - * - * Inheritance happens to capture this in a natural way. In some future, we - * may not use inheritance anymore. That is OK because no code outside of - * sce.js and sceSpecs.js would need to be aware of this detail. - */ - - this.$get = ['$parse', '$sceDelegate', function( - $parse, $sceDelegate) { - // Support: IE 9-11 only - // Prereq: Ensure that we're not running in IE<11 quirks mode. In that mode, IE < 11 allow - // the "expression(javascript expression)" syntax which is insecure. - if (enabled && msie < 8) { - throw $sceMinErr('iequirks', - 'Strict Contextual Escaping does not support Internet Explorer version < 11 in quirks ' + - 'mode. You can fix this by adding the text to the top of your HTML ' + - 'document. See http://docs.angularjs.org/api/ng.$sce for more information.'); - } - - var sce = shallowCopy(SCE_CONTEXTS); - - /** - * @ngdoc method - * @name $sce#isEnabled - * @kind function - * - * @return {Boolean} true if SCE is enabled, false otherwise. If you want to set the value, you - * have to do it at module config time on {@link ng.$sceProvider $sceProvider}. - * - * @description - * Returns a boolean indicating if SCE is enabled. - */ - sce.isEnabled = function() { - return enabled; - }; - sce.trustAs = $sceDelegate.trustAs; - sce.getTrusted = $sceDelegate.getTrusted; - sce.valueOf = $sceDelegate.valueOf; - - if (!enabled) { - sce.trustAs = sce.getTrusted = function(type, value) { return value; }; - sce.valueOf = identity; - } - - /** - * @ngdoc method - * @name $sce#parseAs - * - * @description - * Converts Angular {@link guide/expression expression} into a function. This is like {@link - * ng.$parse $parse} and is identical when the expression is a literal constant. Otherwise, it - * wraps the expression in a call to {@link ng.$sce#getTrusted $sce.getTrusted(*type*, - * *result*)} - * - * @param {string} type The kind of SCE context in which this result will be used. - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - sce.parseAs = function sceParseAs(type, expr) { - var parsed = $parse(expr); - if (parsed.literal && parsed.constant) { - return parsed; - } else { - return $parse(expr, function(value) { - return sce.getTrusted(type, value); - }); - } - }; - - /** - * @ngdoc method - * @name $sce#trustAs - * - * @description - * Delegates to {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}. As such, - * returns an object that is trusted by angular for use in specified strict contextual - * escaping contexts (such as ng-bind-html, ng-include, any src attribute - * interpolation, any dom event binding attribute interpolation such as for onclick, etc.) - * that uses the provided value. See * {@link ng.$sce $sce} for enabling strict contextual - * escaping. - * - * @param {string} type The kind of context in which this value is safe for use. e.g. url, - * resourceUrl, html, js and css. - * @param {*} value The value that that should be considered trusted/safe. - * @returns {*} A value that can be used to stand in for the provided `value` in places - * where Angular expects a $sce.trustAs() return value. - */ - - /** - * @ngdoc method - * @name $sce#trustAsHtml - * - * @description - * Shorthand method. `$sce.trustAsHtml(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.HTML, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedHtml - * $sce.getTrustedHtml(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#trustAsUrl - * - * @description - * Shorthand method. `$sce.trustAsUrl(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.URL, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedUrl - * $sce.getTrustedUrl(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#trustAsResourceUrl - * - * @description - * Shorthand method. `$sce.trustAsResourceUrl(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.RESOURCE_URL, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedResourceUrl - * $sce.getTrustedResourceUrl(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the return - * value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#trustAsJs - * - * @description - * Shorthand method. `$sce.trustAsJs(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.JS, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedJs - * $sce.getTrustedJs(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#getTrusted - * - * @description - * Delegates to {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted`}. As such, - * takes the result of a {@link ng.$sce#trustAs `$sce.trustAs`}() call and returns the - * originally supplied value if the queried context type is a supertype of the created type. - * If this condition isn't satisfied, throws an exception. - * - * @param {string} type The kind of context in which this value is to be used. - * @param {*} maybeTrusted The result of a prior {@link ng.$sce#trustAs `$sce.trustAs`} - * call. - * @returns {*} The value the was originally provided to - * {@link ng.$sce#trustAs `$sce.trustAs`} if valid in this context. - * Otherwise, throws an exception. - */ - - /** - * @ngdoc method - * @name $sce#getTrustedHtml - * - * @description - * Shorthand method. `$sce.getTrustedHtml(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.HTML, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.HTML, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedCss - * - * @description - * Shorthand method. `$sce.getTrustedCss(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.CSS, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.CSS, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedUrl - * - * @description - * Shorthand method. `$sce.getTrustedUrl(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.URL, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.URL, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedResourceUrl - * - * @description - * Shorthand method. `$sce.getTrustedResourceUrl(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.RESOURCE_URL, value)`} - * - * @param {*} value The value to pass to `$sceDelegate.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.RESOURCE_URL, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedJs - * - * @description - * Shorthand method. `$sce.getTrustedJs(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.JS, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.JS, value)` - */ - - /** - * @ngdoc method - * @name $sce#parseAsHtml - * - * @description - * Shorthand method. `$sce.parseAsHtml(expression string)` → - * {@link ng.$sce#parseAs `$sce.parseAs($sce.HTML, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsCss - * - * @description - * Shorthand method. `$sce.parseAsCss(value)` → - * {@link ng.$sce#parseAs `$sce.parseAs($sce.CSS, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsUrl - * - * @description - * Shorthand method. `$sce.parseAsUrl(value)` → - * {@link ng.$sce#parseAs `$sce.parseAs($sce.URL, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsResourceUrl - * - * @description - * Shorthand method. `$sce.parseAsResourceUrl(value)` → - * {@link ng.$sce#parseAs `$sce.parseAs($sce.RESOURCE_URL, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsJs - * - * @description - * Shorthand method. `$sce.parseAsJs(value)` → - * {@link ng.$sce#parseAs `$sce.parseAs($sce.JS, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - // Shorthand delegations. - var parse = sce.parseAs, - getTrusted = sce.getTrusted, - trustAs = sce.trustAs; - - forEach(SCE_CONTEXTS, function(enumValue, name) { - var lName = lowercase(name); - sce[snakeToCamel('parse_as_' + lName)] = function(expr) { - return parse(enumValue, expr); - }; - sce[snakeToCamel('get_trusted_' + lName)] = function(value) { - return getTrusted(enumValue, value); - }; - sce[snakeToCamel('trust_as_' + lName)] = function(value) { - return trustAs(enumValue, value); - }; - }); - - return sce; - }]; -} - -/* exported $SnifferProvider */ - -/** - * !!! This is an undocumented "private" service !!! - * - * @name $sniffer - * @requires $window - * @requires $document - * @this - * - * @property {boolean} history Does the browser support html5 history api ? - * @property {boolean} transitions Does the browser support CSS transition events ? - * @property {boolean} animations Does the browser support CSS animation events ? - * - * @description - * This is very simple implementation of testing browser's features. - */ -function $SnifferProvider() { - this.$get = ['$window', '$document', function($window, $document) { - var eventSupport = {}, - // Chrome Packaged Apps are not allowed to access `history.pushState`. - // If not sandboxed, they can be detected by the presence of `chrome.app.runtime` - // (see https://developer.chrome.com/apps/api_index). If sandboxed, they can be detected by - // the presence of an extension runtime ID and the absence of other Chrome runtime APIs - // (see https://developer.chrome.com/apps/manifest/sandbox). - isChromePackagedApp = - $window.chrome && - ($window.chrome.app && $window.chrome.app.runtime || - !$window.chrome.app && $window.chrome.runtime && $window.chrome.runtime.id), - hasHistoryPushState = !isChromePackagedApp && $window.history && $window.history.pushState, - android = - toInt((/android (\d+)/.exec(lowercase(($window.navigator || {}).userAgent)) || [])[1]), - boxee = /Boxee/i.test(($window.navigator || {}).userAgent), - document = $document[0] || {}, - bodyStyle = document.body && document.body.style, - transitions = false, - animations = false; - - if (bodyStyle) { - // Support: Android <5, Blackberry Browser 10, default Chrome in Android 4.4.x - // Mentioned browsers need a -webkit- prefix for transitions & animations. - transitions = !!('transition' in bodyStyle || 'webkitTransition' in bodyStyle); - animations = !!('animation' in bodyStyle || 'webkitAnimation' in bodyStyle); - } - - - return { - // Android has history.pushState, but it does not update location correctly - // so let's not use the history API at all. - // http://code.google.com/p/android/issues/detail?id=17471 - // https://github.com/angular/angular.js/issues/904 - - // older webkit browser (533.9) on Boxee box has exactly the same problem as Android has - // so let's not use the history API also - // We are purposefully using `!(android < 4)` to cover the case when `android` is undefined - history: !!(hasHistoryPushState && !(android < 4) && !boxee), - hasEvent: function(event) { - // Support: IE 9-11 only - // IE9 implements 'input' event it's so fubared that we rather pretend that it doesn't have - // it. In particular the event is not fired when backspace or delete key are pressed or - // when cut operation is performed. - // IE10+ implements 'input' event but it erroneously fires under various situations, - // e.g. when placeholder changes, or a form is focused. - if (event === 'input' && msie) return false; - - if (isUndefined(eventSupport[event])) { - var divElm = document.createElement('div'); - eventSupport[event] = 'on' + event in divElm; - } - - return eventSupport[event]; - }, - csp: csp(), - transitions: transitions, - animations: animations, - android: android - }; - }]; -} - -var $templateRequestMinErr = minErr('$compile'); - -/** - * @ngdoc provider - * @name $templateRequestProvider - * @this - * - * @description - * Used to configure the options passed to the {@link $http} service when making a template request. - * - * For example, it can be used for specifying the "Accept" header that is sent to the server, when - * requesting a template. - */ -function $TemplateRequestProvider() { - - var httpOptions; - - /** - * @ngdoc method - * @name $templateRequestProvider#httpOptions - * @description - * The options to be passed to the {@link $http} service when making the request. - * You can use this to override options such as the "Accept" header for template requests. - * - * The {@link $templateRequest} will set the `cache` and the `transformResponse` properties of the - * options if not overridden here. - * - * @param {string=} value new value for the {@link $http} options. - * @returns {string|self} Returns the {@link $http} options when used as getter and self if used as setter. - */ - this.httpOptions = function(val) { - if (val) { - httpOptions = val; - return this; - } - return httpOptions; - }; - - /** - * @ngdoc service - * @name $templateRequest - * - * @description - * The `$templateRequest` service runs security checks then downloads the provided template using - * `$http` and, upon success, stores the contents inside of `$templateCache`. If the HTTP request - * fails or the response data of the HTTP request is empty, a `$compile` error will be thrown (the - * exception can be thwarted by setting the 2nd parameter of the function to true). Note that the - * contents of `$templateCache` are trusted, so the call to `$sce.getTrustedUrl(tpl)` is omitted - * when `tpl` is of type string and `$templateCache` has the matching entry. - * - * If you want to pass custom options to the `$http` service, such as setting the Accept header you - * can configure this via {@link $templateRequestProvider#httpOptions}. - * - * @param {string|TrustedResourceUrl} tpl The HTTP request template URL - * @param {boolean=} ignoreRequestError Whether or not to ignore the exception when the request fails or the template is empty - * - * @return {Promise} a promise for the HTTP response data of the given URL. - * - * @property {number} totalPendingRequests total amount of pending template requests being downloaded. - */ - this.$get = ['$exceptionHandler', '$templateCache', '$http', '$q', '$sce', - function($exceptionHandler, $templateCache, $http, $q, $sce) { - - function handleRequestFn(tpl, ignoreRequestError) { - handleRequestFn.totalPendingRequests++; - - // We consider the template cache holds only trusted templates, so - // there's no need to go through whitelisting again for keys that already - // are included in there. This also makes Angular accept any script - // directive, no matter its name. However, we still need to unwrap trusted - // types. - if (!isString(tpl) || isUndefined($templateCache.get(tpl))) { - tpl = $sce.getTrustedResourceUrl(tpl); - } - - var transformResponse = $http.defaults && $http.defaults.transformResponse; - - if (isArray(transformResponse)) { - transformResponse = transformResponse.filter(function(transformer) { - return transformer !== defaultHttpResponseTransform; - }); - } else if (transformResponse === defaultHttpResponseTransform) { - transformResponse = null; - } - - return $http.get(tpl, extend({ - cache: $templateCache, - transformResponse: transformResponse - }, httpOptions)) - .finally(function() { - handleRequestFn.totalPendingRequests--; - }) - .then(function(response) { - $templateCache.put(tpl, response.data); - return response.data; - }, handleError); - - function handleError(resp) { - if (!ignoreRequestError) { - resp = $templateRequestMinErr('tpload', - 'Failed to load template: {0} (HTTP status: {1} {2})', - tpl, resp.status, resp.statusText); - - $exceptionHandler(resp); - } - - return $q.reject(resp); - } - } - - handleRequestFn.totalPendingRequests = 0; - - return handleRequestFn; - } - ]; -} - -/** @this */ -function $$TestabilityProvider() { - this.$get = ['$rootScope', '$browser', '$location', - function($rootScope, $browser, $location) { - - /** - * @name $testability - * - * @description - * The private $$testability service provides a collection of methods for use when debugging - * or by automated test and debugging tools. - */ - var testability = {}; - - /** - * @name $$testability#findBindings - * - * @description - * Returns an array of elements that are bound (via ng-bind or {{}}) - * to expressions matching the input. - * - * @param {Element} element The element root to search from. - * @param {string} expression The binding expression to match. - * @param {boolean} opt_exactMatch If true, only returns exact matches - * for the expression. Filters and whitespace are ignored. - */ - testability.findBindings = function(element, expression, opt_exactMatch) { - var bindings = element.getElementsByClassName('ng-binding'); - var matches = []; - forEach(bindings, function(binding) { - var dataBinding = angular.element(binding).data('$binding'); - if (dataBinding) { - forEach(dataBinding, function(bindingName) { - if (opt_exactMatch) { - var matcher = new RegExp('(^|\\s)' + escapeForRegexp(expression) + '(\\s|\\||$)'); - if (matcher.test(bindingName)) { - matches.push(binding); - } - } else { - if (bindingName.indexOf(expression) !== -1) { - matches.push(binding); - } - } - }); - } - }); - return matches; - }; - - /** - * @name $$testability#findModels - * - * @description - * Returns an array of elements that are two-way found via ng-model to - * expressions matching the input. - * - * @param {Element} element The element root to search from. - * @param {string} expression The model expression to match. - * @param {boolean} opt_exactMatch If true, only returns exact matches - * for the expression. - */ - testability.findModels = function(element, expression, opt_exactMatch) { - var prefixes = ['ng-', 'data-ng-', 'ng\\:']; - for (var p = 0; p < prefixes.length; ++p) { - var attributeEquals = opt_exactMatch ? '=' : '*='; - var selector = '[' + prefixes[p] + 'model' + attributeEquals + '"' + expression + '"]'; - var elements = element.querySelectorAll(selector); - if (elements.length) { - return elements; - } - } - }; - - /** - * @name $$testability#getLocation - * - * @description - * Shortcut for getting the location in a browser agnostic way. Returns - * the path, search, and hash. (e.g. /path?a=b#hash) - */ - testability.getLocation = function() { - return $location.url(); - }; - - /** - * @name $$testability#setLocation - * - * @description - * Shortcut for navigating to a location without doing a full page reload. - * - * @param {string} url The location url (path, search and hash, - * e.g. /path?a=b#hash) to go to. - */ - testability.setLocation = function(url) { - if (url !== $location.url()) { - $location.url(url); - $rootScope.$digest(); - } - }; - - /** - * @name $$testability#whenStable - * - * @description - * Calls the callback when $timeout and $http requests are completed. - * - * @param {function} callback - */ - testability.whenStable = function(callback) { - $browser.notifyWhenNoOutstandingRequests(callback); - }; - - return testability; - }]; -} - -/** @this */ -function $TimeoutProvider() { - this.$get = ['$rootScope', '$browser', '$q', '$$q', '$exceptionHandler', - function($rootScope, $browser, $q, $$q, $exceptionHandler) { - - var deferreds = {}; - - - /** - * @ngdoc service - * @name $timeout - * - * @description - * Angular's wrapper for `window.setTimeout`. The `fn` function is wrapped into a try/catch - * block and delegates any exceptions to - * {@link ng.$exceptionHandler $exceptionHandler} service. - * - * The return value of calling `$timeout` is a promise, which will be resolved when - * the delay has passed and the timeout function, if provided, is executed. - * - * To cancel a timeout request, call `$timeout.cancel(promise)`. - * - * In tests you can use {@link ngMock.$timeout `$timeout.flush()`} to - * synchronously flush the queue of deferred functions. - * - * If you only want a promise that will be resolved after some specified delay - * then you can call `$timeout` without the `fn` function. - * - * @param {function()=} fn A function, whose execution should be delayed. - * @param {number=} [delay=0] Delay in milliseconds. - * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. - * @param {...*=} Pass additional parameters to the executed function. - * @returns {Promise} Promise that will be resolved when the timeout is reached. The promise - * will be resolved with the return value of the `fn` function. - * - */ - function timeout(fn, delay, invokeApply) { - if (!isFunction(fn)) { - invokeApply = delay; - delay = fn; - fn = noop; - } - - var args = sliceArgs(arguments, 3), - skipApply = (isDefined(invokeApply) && !invokeApply), - deferred = (skipApply ? $$q : $q).defer(), - promise = deferred.promise, - timeoutId; - - timeoutId = $browser.defer(function() { - try { - deferred.resolve(fn.apply(null, args)); - } catch (e) { - deferred.reject(e); - $exceptionHandler(e); - } finally { - delete deferreds[promise.$$timeoutId]; - } - - if (!skipApply) $rootScope.$apply(); - }, delay); - - promise.$$timeoutId = timeoutId; - deferreds[timeoutId] = deferred; - - return promise; - } - - - /** - * @ngdoc method - * @name $timeout#cancel - * - * @description - * Cancels a task associated with the `promise`. As a result of this, the promise will be - * resolved with a rejection. - * - * @param {Promise=} promise Promise returned by the `$timeout` function. - * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully - * canceled. - */ - timeout.cancel = function(promise) { - if (promise && promise.$$timeoutId in deferreds) { - // Timeout cancels should not report an unhandled promise. - deferreds[promise.$$timeoutId].promise.catch(noop); - deferreds[promise.$$timeoutId].reject('canceled'); - delete deferreds[promise.$$timeoutId]; - return $browser.defer.cancel(promise.$$timeoutId); - } - return false; - }; - - return timeout; - }]; -} - -// NOTE: The usage of window and document instead of $window and $document here is -// deliberate. This service depends on the specific behavior of anchor nodes created by the -// browser (resolving and parsing URLs) that is unlikely to be provided by mock objects and -// cause us to break tests. In addition, when the browser resolves a URL for XHR, it -// doesn't know about mocked locations and resolves URLs to the real document - which is -// exactly the behavior needed here. There is little value is mocking these out for this -// service. -var urlParsingNode = window.document.createElement('a'); -var originUrl = urlResolve(window.location.href); - - -/** - * - * Implementation Notes for non-IE browsers - * ---------------------------------------- - * Assigning a URL to the href property of an anchor DOM node, even one attached to the DOM, - * results both in the normalizing and parsing of the URL. Normalizing means that a relative - * URL will be resolved into an absolute URL in the context of the application document. - * Parsing means that the anchor node's host, hostname, protocol, port, pathname and related - * properties are all populated to reflect the normalized URL. This approach has wide - * compatibility - Safari 1+, Mozilla 1+, Opera 7+,e etc. See - * http://www.aptana.com/reference/html/api/HTMLAnchorElement.html - * - * Implementation Notes for IE - * --------------------------- - * IE <= 10 normalizes the URL when assigned to the anchor node similar to the other - * browsers. However, the parsed components will not be set if the URL assigned did not specify - * them. (e.g. if you assign a.href = "foo", then a.protocol, a.host, etc. will be empty.) We - * work around that by performing the parsing in a 2nd step by taking a previously normalized - * URL (e.g. by assigning to a.href) and assigning it a.href again. This correctly populates the - * properties such as protocol, hostname, port, etc. - * - * References: - * http://developer.mozilla.org/en-US/docs/Web/API/HTMLAnchorElement - * http://www.aptana.com/reference/html/api/HTMLAnchorElement.html - * http://url.spec.whatwg.org/#urlutils - * https://github.com/angular/angular.js/pull/2902 - * http://james.padolsey.com/javascript/parsing-urls-with-the-dom/ - * - * @kind function - * @param {string} url The URL to be parsed. - * @description Normalizes and parses a URL. - * @returns {object} Returns the normalized URL as a dictionary. - * - * | member name | Description | - * |---------------|----------------| - * | href | A normalized version of the provided URL if it was not an absolute URL | - * | protocol | The protocol including the trailing colon | - * | host | The host and port (if the port is non-default) of the normalizedUrl | - * | search | The search params, minus the question mark | - * | hash | The hash string, minus the hash symbol - * | hostname | The hostname - * | port | The port, without ":" - * | pathname | The pathname, beginning with "/" - * - */ -function urlResolve(url) { - var href = url; - - // Support: IE 9-11 only - if (msie) { - // Normalize before parse. Refer Implementation Notes on why this is - // done in two steps on IE. - urlParsingNode.setAttribute('href', href); - href = urlParsingNode.href; - } - - urlParsingNode.setAttribute('href', href); - - // urlParsingNode provides the UrlUtils interface - http://url.spec.whatwg.org/#urlutils - return { - href: urlParsingNode.href, - protocol: urlParsingNode.protocol ? urlParsingNode.protocol.replace(/:$/, '') : '', - host: urlParsingNode.host, - search: urlParsingNode.search ? urlParsingNode.search.replace(/^\?/, '') : '', - hash: urlParsingNode.hash ? urlParsingNode.hash.replace(/^#/, '') : '', - hostname: urlParsingNode.hostname, - port: urlParsingNode.port, - pathname: (urlParsingNode.pathname.charAt(0) === '/') - ? urlParsingNode.pathname - : '/' + urlParsingNode.pathname - }; -} - -/** - * Parse a request URL and determine whether this is a same-origin request as the application document. - * - * @param {string|object} requestUrl The url of the request as a string that will be resolved - * or a parsed URL object. - * @returns {boolean} Whether the request is for the same origin as the application document. - */ -function urlIsSameOrigin(requestUrl) { - var parsed = (isString(requestUrl)) ? urlResolve(requestUrl) : requestUrl; - return (parsed.protocol === originUrl.protocol && - parsed.host === originUrl.host); -} - -/** - * @ngdoc service - * @name $window - * @this - * - * @description - * A reference to the browser's `window` object. While `window` - * is globally available in JavaScript, it causes testability problems, because - * it is a global variable. In angular we always refer to it through the - * `$window` service, so it may be overridden, removed or mocked for testing. - * - * Expressions, like the one defined for the `ngClick` directive in the example - * below, are evaluated with respect to the current scope. Therefore, there is - * no risk of inadvertently coding in a dependency on a global value in such an - * expression. - * - * @example - - - -
- - -
- - - it('should display the greeting in the input box', function() { - element(by.model('greeting')).sendKeys('Hello, E2E Tests'); - // If we click the button it will block the test runner - // element(':button').click(); - }); - - - */ -function $WindowProvider() { - this.$get = valueFn(window); -} - -/** - * @name $$cookieReader - * @requires $document - * - * @description - * This is a private service for reading cookies used by $http and ngCookies - * - * @return {Object} a key/value map of the current cookies - */ -function $$CookieReader($document) { - var rawDocument = $document[0] || {}; - var lastCookies = {}; - var lastCookieString = ''; - - function safeDecodeURIComponent(str) { - try { - return decodeURIComponent(str); - } catch (e) { - return str; - } - } - - return function() { - var cookieArray, cookie, i, index, name; - var currentCookieString = rawDocument.cookie || ''; - - if (currentCookieString !== lastCookieString) { - lastCookieString = currentCookieString; - cookieArray = lastCookieString.split('; '); - lastCookies = {}; - - for (i = 0; i < cookieArray.length; i++) { - cookie = cookieArray[i]; - index = cookie.indexOf('='); - if (index > 0) { //ignore nameless cookies - name = safeDecodeURIComponent(cookie.substring(0, index)); - // the first value that is seen for a cookie is the most - // specific one. values for the same cookie name that - // follow are for less specific paths. - if (isUndefined(lastCookies[name])) { - lastCookies[name] = safeDecodeURIComponent(cookie.substring(index + 1)); - } - } - } - } - return lastCookies; - }; -} - -$$CookieReader.$inject = ['$document']; - -/** @this */ -function $$CookieReaderProvider() { - this.$get = $$CookieReader; -} - -/* global currencyFilter: true, - dateFilter: true, - filterFilter: true, - jsonFilter: true, - limitToFilter: true, - lowercaseFilter: true, - numberFilter: true, - orderByFilter: true, - uppercaseFilter: true, - */ - -/** - * @ngdoc provider - * @name $filterProvider - * @description - * - * Filters are just functions which transform input to an output. However filters need to be - * Dependency Injected. To achieve this a filter definition consists of a factory function which is - * annotated with dependencies and is responsible for creating a filter function. - * - *
- * **Note:** Filter names must be valid angular {@link expression} identifiers, such as `uppercase` or `orderBy`. - * Names with special characters, such as hyphens and dots, are not allowed. If you wish to namespace - * your filters, then you can use capitalization (`myappSubsectionFilterx`) or underscores - * (`myapp_subsection_filterx`). - *
- * - * ```js - * // Filter registration - * function MyModule($provide, $filterProvider) { - * // create a service to demonstrate injection (not always needed) - * $provide.value('greet', function(name){ - * return 'Hello ' + name + '!'; - * }); - * - * // register a filter factory which uses the - * // greet service to demonstrate DI. - * $filterProvider.register('greet', function(greet){ - * // return the filter function which uses the greet service - * // to generate salutation - * return function(text) { - * // filters need to be forgiving so check input validity - * return text && greet(text) || text; - * }; - * }); - * } - * ``` - * - * The filter function is registered with the `$injector` under the filter name suffix with - * `Filter`. - * - * ```js - * it('should be the same instance', inject( - * function($filterProvider) { - * $filterProvider.register('reverse', function(){ - * return ...; - * }); - * }, - * function($filter, reverseFilter) { - * expect($filter('reverse')).toBe(reverseFilter); - * }); - * ``` - * - * - * For more information about how angular filters work, and how to create your own filters, see - * {@link guide/filter Filters} in the Angular Developer Guide. - */ - -/** - * @ngdoc service - * @name $filter - * @kind function - * @description - * Filters are used for formatting data displayed to the user. - * - * They can be used in view templates, controllers or services.Angular comes - * with a collection of [built-in filters](api/ng/filter), but it is easy to - * define your own as well. - * - * The general syntax in templates is as follows: - * - * ```html - * {{ expression [| filter_name[:parameter_value] ... ] }} - * ``` - * - * @param {String} name Name of the filter function to retrieve - * @return {Function} the filter function - * @example - - -
-

{{ originalText }}

-

{{ filteredText }}

-
- - - - angular.module('filterExample', []) - .controller('MainCtrl', function($scope, $filter) { - $scope.originalText = 'hello'; - $scope.filteredText = $filter('uppercase')($scope.originalText); - }); - - - */ -$FilterProvider.$inject = ['$provide']; -/** @this */ -function $FilterProvider($provide) { - var suffix = 'Filter'; - - /** - * @ngdoc method - * @name $filterProvider#register - * @param {string|Object} name Name of the filter function, or an object map of filters where - * the keys are the filter names and the values are the filter factories. - * - *
- * **Note:** Filter names must be valid angular {@link expression} identifiers, such as `uppercase` or `orderBy`. - * Names with special characters, such as hyphens and dots, are not allowed. If you wish to namespace - * your filters, then you can use capitalization (`myappSubsectionFilterx`) or underscores - * (`myapp_subsection_filterx`). - *
- * @param {Function} factory If the first argument was a string, a factory function for the filter to be registered. - * @returns {Object} Registered filter instance, or if a map of filters was provided then a map - * of the registered filter instances. - */ - function register(name, factory) { - if (isObject(name)) { - var filters = {}; - forEach(name, function(filter, key) { - filters[key] = register(key, filter); - }); - return filters; - } else { - return $provide.factory(name + suffix, factory); - } - } - this.register = register; - - this.$get = ['$injector', function($injector) { - return function(name) { - return $injector.get(name + suffix); - }; - }]; - - //////////////////////////////////////// - - /* global - currencyFilter: false, - dateFilter: false, - filterFilter: false, - jsonFilter: false, - limitToFilter: false, - lowercaseFilter: false, - numberFilter: false, - orderByFilter: false, - uppercaseFilter: false - */ - - register('currency', currencyFilter); - register('date', dateFilter); - register('filter', filterFilter); - register('json', jsonFilter); - register('limitTo', limitToFilter); - register('lowercase', lowercaseFilter); - register('number', numberFilter); - register('orderBy', orderByFilter); - register('uppercase', uppercaseFilter); -} - -/** - * @ngdoc filter - * @name filter - * @kind function - * - * @description - * Selects a subset of items from `array` and returns it as a new array. - * - * @param {Array} array The source array. - * @param {string|Object|function()} expression The predicate to be used for selecting items from - * `array`. - * - * Can be one of: - * - * - `string`: The string is used for matching against the contents of the `array`. All strings or - * objects with string properties in `array` that match this string will be returned. This also - * applies to nested object properties. - * The predicate can be negated by prefixing the string with `!`. - * - * - `Object`: A pattern object can be used to filter specific properties on objects contained - * by `array`. For example `{name:"M", phone:"1"}` predicate will return an array of items - * which have property `name` containing "M" and property `phone` containing "1". A special - * property name (`$` by default) can be used (e.g. as in `{$: "text"}`) to accept a match - * against any property of the object or its nested object properties. That's equivalent to the - * simple substring match with a `string` as described above. The special property name can be - * overwritten, using the `anyPropertyKey` parameter. - * The predicate can be negated by prefixing the string with `!`. - * For example `{name: "!M"}` predicate will return an array of items which have property `name` - * not containing "M". - * - * Note that a named property will match properties on the same level only, while the special - * `$` property will match properties on the same level or deeper. E.g. an array item like - * `{name: {first: 'John', last: 'Doe'}}` will **not** be matched by `{name: 'John'}`, but - * **will** be matched by `{$: 'John'}`. - * - * - `function(value, index, array)`: A predicate function can be used to write arbitrary filters. - * The function is called for each element of the array, with the element, its index, and - * the entire array itself as arguments. - * - * The final result is an array of those elements that the predicate returned true for. - * - * @param {function(actual, expected)|true|false} [comparator] Comparator which is used in - * determining if the expected value (from the filter expression) and actual value (from - * the object in the array) should be considered a match. - * - * Can be one of: - * - * - `function(actual, expected)`: - * The function will be given the object value and the predicate value to compare and - * should return true if both values should be considered equal. - * - * - `true`: A shorthand for `function(actual, expected) { return angular.equals(actual, expected)}`. - * This is essentially strict comparison of expected and actual. - * - * - `false`: A short hand for a function which will look for a substring match in a case - * insensitive way. Primitive values are converted to strings. Objects are not compared against - * primitives, unless they have a custom `toString` method (e.g. `Date` objects). - * - * - * Defaults to `false`. - * - * @param {string} [anyPropertyKey] The special property name that matches against any property. - * By default `$`. - * - * @example - - -
- - - - - - - - -
NamePhone
{{friend.name}}{{friend.phone}}
-
-
-
-
-
- - - - - - -
NamePhone
{{friendObj.name}}{{friendObj.phone}}
- - - var expectFriendNames = function(expectedNames, key) { - element.all(by.repeater(key + ' in friends').column(key + '.name')).then(function(arr) { - arr.forEach(function(wd, i) { - expect(wd.getText()).toMatch(expectedNames[i]); - }); - }); - }; - - it('should search across all fields when filtering with a string', function() { - var searchText = element(by.model('searchText')); - searchText.clear(); - searchText.sendKeys('m'); - expectFriendNames(['Mary', 'Mike', 'Adam'], 'friend'); - - searchText.clear(); - searchText.sendKeys('76'); - expectFriendNames(['John', 'Julie'], 'friend'); - }); - - it('should search in specific fields when filtering with a predicate object', function() { - var searchAny = element(by.model('search.$')); - searchAny.clear(); - searchAny.sendKeys('i'); - expectFriendNames(['Mary', 'Mike', 'Julie', 'Juliette'], 'friendObj'); - }); - it('should use a equal comparison when comparator is true', function() { - var searchName = element(by.model('search.name')); - var strict = element(by.model('strict')); - searchName.clear(); - searchName.sendKeys('Julie'); - strict.click(); - expectFriendNames(['Julie'], 'friendObj'); - }); - - - */ - -function filterFilter() { - return function(array, expression, comparator, anyPropertyKey) { - if (!isArrayLike(array)) { - if (array == null) { - return array; - } else { - throw minErr('filter')('notarray', 'Expected array but received: {0}', array); - } - } - - anyPropertyKey = anyPropertyKey || '$'; - var expressionType = getTypeForFilter(expression); - var predicateFn; - var matchAgainstAnyProp; - - switch (expressionType) { - case 'function': - predicateFn = expression; - break; - case 'boolean': - case 'null': - case 'number': - case 'string': - matchAgainstAnyProp = true; - // falls through - case 'object': - predicateFn = createPredicateFn(expression, comparator, anyPropertyKey, matchAgainstAnyProp); - break; - default: - return array; - } - - return Array.prototype.filter.call(array, predicateFn); - }; -} - -// Helper functions for `filterFilter` -function createPredicateFn(expression, comparator, anyPropertyKey, matchAgainstAnyProp) { - var shouldMatchPrimitives = isObject(expression) && (anyPropertyKey in expression); - var predicateFn; - - if (comparator === true) { - comparator = equals; - } else if (!isFunction(comparator)) { - comparator = function(actual, expected) { - if (isUndefined(actual)) { - // No substring matching against `undefined` - return false; - } - if ((actual === null) || (expected === null)) { - // No substring matching against `null`; only match against `null` - return actual === expected; - } - if (isObject(expected) || (isObject(actual) && !hasCustomToString(actual))) { - // Should not compare primitives against objects, unless they have custom `toString` method - return false; - } - - actual = lowercase('' + actual); - expected = lowercase('' + expected); - return actual.indexOf(expected) !== -1; - }; - } - - predicateFn = function(item) { - if (shouldMatchPrimitives && !isObject(item)) { - return deepCompare(item, expression[anyPropertyKey], comparator, anyPropertyKey, false); - } - return deepCompare(item, expression, comparator, anyPropertyKey, matchAgainstAnyProp); - }; - - return predicateFn; -} - -function deepCompare(actual, expected, comparator, anyPropertyKey, matchAgainstAnyProp, dontMatchWholeObject) { - var actualType = getTypeForFilter(actual); - var expectedType = getTypeForFilter(expected); - - if ((expectedType === 'string') && (expected.charAt(0) === '!')) { - return !deepCompare(actual, expected.substring(1), comparator, anyPropertyKey, matchAgainstAnyProp); - } else if (isArray(actual)) { - // In case `actual` is an array, consider it a match - // if ANY of it's items matches `expected` - return actual.some(function(item) { - return deepCompare(item, expected, comparator, anyPropertyKey, matchAgainstAnyProp); - }); - } - - switch (actualType) { - case 'object': - var key; - if (matchAgainstAnyProp) { - for (key in actual) { - if ((key.charAt(0) !== '$') && deepCompare(actual[key], expected, comparator, anyPropertyKey, true)) { - return true; - } - } - return dontMatchWholeObject ? false : deepCompare(actual, expected, comparator, anyPropertyKey, false); - } else if (expectedType === 'object') { - for (key in expected) { - var expectedVal = expected[key]; - if (isFunction(expectedVal) || isUndefined(expectedVal)) { - continue; - } - - var matchAnyProperty = key === anyPropertyKey; - var actualVal = matchAnyProperty ? actual : actual[key]; - if (!deepCompare(actualVal, expectedVal, comparator, anyPropertyKey, matchAnyProperty, matchAnyProperty)) { - return false; - } - } - return true; - } else { - return comparator(actual, expected); - } - case 'function': - return false; - default: - return comparator(actual, expected); - } -} - -// Used for easily differentiating between `null` and actual `object` -function getTypeForFilter(val) { - return (val === null) ? 'null' : typeof val; -} - -var MAX_DIGITS = 22; -var DECIMAL_SEP = '.'; -var ZERO_CHAR = '0'; - -/** - * @ngdoc filter - * @name currency - * @kind function - * - * @description - * Formats a number as a currency (ie $1,234.56). When no currency symbol is provided, default - * symbol for current locale is used. - * - * @param {number} amount Input to filter. - * @param {string=} symbol Currency symbol or identifier to be displayed. - * @param {number=} fractionSize Number of decimal places to round the amount to, defaults to default max fraction size for current locale - * @returns {string} Formatted number. - * - * - * @example - - - -
-
- default currency symbol ($): {{amount | currency}}
- custom currency identifier (USD$): {{amount | currency:"USD$"}}
- no fractions (0): {{amount | currency:"USD$":0}} -
- - - it('should init with 1234.56', function() { - expect(element(by.id('currency-default')).getText()).toBe('$1,234.56'); - expect(element(by.id('currency-custom')).getText()).toBe('USD$1,234.56'); - expect(element(by.id('currency-no-fractions')).getText()).toBe('USD$1,235'); - }); - it('should update', function() { - if (browser.params.browser === 'safari') { - // Safari does not understand the minus key. See - // https://github.com/angular/protractor/issues/481 - return; - } - element(by.model('amount')).clear(); - element(by.model('amount')).sendKeys('-1234'); - expect(element(by.id('currency-default')).getText()).toBe('-$1,234.00'); - expect(element(by.id('currency-custom')).getText()).toBe('-USD$1,234.00'); - expect(element(by.id('currency-no-fractions')).getText()).toBe('-USD$1,234'); - }); - - - */ -currencyFilter.$inject = ['$locale']; -function currencyFilter($locale) { - var formats = $locale.NUMBER_FORMATS; - return function(amount, currencySymbol, fractionSize) { - if (isUndefined(currencySymbol)) { - currencySymbol = formats.CURRENCY_SYM; - } - - if (isUndefined(fractionSize)) { - fractionSize = formats.PATTERNS[1].maxFrac; - } - - // if null or undefined pass it through - return (amount == null) - ? amount - : formatNumber(amount, formats.PATTERNS[1], formats.GROUP_SEP, formats.DECIMAL_SEP, fractionSize). - replace(/\u00A4/g, currencySymbol); - }; -} - -/** - * @ngdoc filter - * @name number - * @kind function - * - * @description - * Formats a number as text. - * - * If the input is null or undefined, it will just be returned. - * If the input is infinite (Infinity or -Infinity), the Infinity symbol '∞' or '-∞' is returned, respectively. - * If the input is not a number an empty string is returned. - * - * - * @param {number|string} number Number to format. - * @param {(number|string)=} fractionSize Number of decimal places to round the number to. - * If this is not provided then the fraction size is computed from the current locale's number - * formatting pattern. In the case of the default locale, it will be 3. - * @returns {string} Number rounded to `fractionSize` appropriately formatted based on the current - * locale (e.g., in the en_US locale it will have "." as the decimal separator and - * include "," group separators after each third digit). - * - * @example - - - -
-
- Default formatting: {{val | number}}
- No fractions: {{val | number:0}}
- Negative number: {{-val | number:4}} -
- - - it('should format numbers', function() { - expect(element(by.id('number-default')).getText()).toBe('1,234.568'); - expect(element(by.binding('val | number:0')).getText()).toBe('1,235'); - expect(element(by.binding('-val | number:4')).getText()).toBe('-1,234.5679'); - }); - - it('should update', function() { - element(by.model('val')).clear(); - element(by.model('val')).sendKeys('3374.333'); - expect(element(by.id('number-default')).getText()).toBe('3,374.333'); - expect(element(by.binding('val | number:0')).getText()).toBe('3,374'); - expect(element(by.binding('-val | number:4')).getText()).toBe('-3,374.3330'); - }); - - - */ -numberFilter.$inject = ['$locale']; -function numberFilter($locale) { - var formats = $locale.NUMBER_FORMATS; - return function(number, fractionSize) { - - // if null or undefined pass it through - return (number == null) - ? number - : formatNumber(number, formats.PATTERNS[0], formats.GROUP_SEP, formats.DECIMAL_SEP, - fractionSize); - }; -} - -/** - * Parse a number (as a string) into three components that can be used - * for formatting the number. - * - * (Significant bits of this parse algorithm came from https://github.com/MikeMcl/big.js/) - * - * @param {string} numStr The number to parse - * @return {object} An object describing this number, containing the following keys: - * - d : an array of digits containing leading zeros as necessary - * - i : the number of the digits in `d` that are to the left of the decimal point - * - e : the exponent for numbers that would need more than `MAX_DIGITS` digits in `d` - * - */ -function parse(numStr) { - var exponent = 0, digits, numberOfIntegerDigits; - var i, j, zeros; - - // Decimal point? - if ((numberOfIntegerDigits = numStr.indexOf(DECIMAL_SEP)) > -1) { - numStr = numStr.replace(DECIMAL_SEP, ''); - } - - // Exponential form? - if ((i = numStr.search(/e/i)) > 0) { - // Work out the exponent. - if (numberOfIntegerDigits < 0) numberOfIntegerDigits = i; - numberOfIntegerDigits += +numStr.slice(i + 1); - numStr = numStr.substring(0, i); - } else if (numberOfIntegerDigits < 0) { - // There was no decimal point or exponent so it is an integer. - numberOfIntegerDigits = numStr.length; - } - - // Count the number of leading zeros. - for (i = 0; numStr.charAt(i) === ZERO_CHAR; i++) { /* empty */ } - - if (i === (zeros = numStr.length)) { - // The digits are all zero. - digits = [0]; - numberOfIntegerDigits = 1; - } else { - // Count the number of trailing zeros - zeros--; - while (numStr.charAt(zeros) === ZERO_CHAR) zeros--; - - // Trailing zeros are insignificant so ignore them - numberOfIntegerDigits -= i; - digits = []; - // Convert string to array of digits without leading/trailing zeros. - for (j = 0; i <= zeros; i++, j++) { - digits[j] = +numStr.charAt(i); - } - } - - // If the number overflows the maximum allowed digits then use an exponent. - if (numberOfIntegerDigits > MAX_DIGITS) { - digits = digits.splice(0, MAX_DIGITS - 1); - exponent = numberOfIntegerDigits - 1; - numberOfIntegerDigits = 1; - } - - return { d: digits, e: exponent, i: numberOfIntegerDigits }; -} - -/** - * Round the parsed number to the specified number of decimal places - * This function changed the parsedNumber in-place - */ -function roundNumber(parsedNumber, fractionSize, minFrac, maxFrac) { - var digits = parsedNumber.d; - var fractionLen = digits.length - parsedNumber.i; - - // determine fractionSize if it is not specified; `+fractionSize` converts it to a number - fractionSize = (isUndefined(fractionSize)) ? Math.min(Math.max(minFrac, fractionLen), maxFrac) : +fractionSize; - - // The index of the digit to where rounding is to occur - var roundAt = fractionSize + parsedNumber.i; - var digit = digits[roundAt]; - - if (roundAt > 0) { - // Drop fractional digits beyond `roundAt` - digits.splice(Math.max(parsedNumber.i, roundAt)); - - // Set non-fractional digits beyond `roundAt` to 0 - for (var j = roundAt; j < digits.length; j++) { - digits[j] = 0; - } - } else { - // We rounded to zero so reset the parsedNumber - fractionLen = Math.max(0, fractionLen); - parsedNumber.i = 1; - digits.length = Math.max(1, roundAt = fractionSize + 1); - digits[0] = 0; - for (var i = 1; i < roundAt; i++) digits[i] = 0; - } - - if (digit >= 5) { - if (roundAt - 1 < 0) { - for (var k = 0; k > roundAt; k--) { - digits.unshift(0); - parsedNumber.i++; - } - digits.unshift(1); - parsedNumber.i++; - } else { - digits[roundAt - 1]++; - } - } - - // Pad out with zeros to get the required fraction length - for (; fractionLen < Math.max(0, fractionSize); fractionLen++) digits.push(0); - - - // Do any carrying, e.g. a digit was rounded up to 10 - var carry = digits.reduceRight(function(carry, d, i, digits) { - d = d + carry; - digits[i] = d % 10; - return Math.floor(d / 10); - }, 0); - if (carry) { - digits.unshift(carry); - parsedNumber.i++; - } -} - -/** - * Format a number into a string - * @param {number} number The number to format - * @param {{ - * minFrac, // the minimum number of digits required in the fraction part of the number - * maxFrac, // the maximum number of digits required in the fraction part of the number - * gSize, // number of digits in each group of separated digits - * lgSize, // number of digits in the last group of digits before the decimal separator - * negPre, // the string to go in front of a negative number (e.g. `-` or `(`)) - * posPre, // the string to go in front of a positive number - * negSuf, // the string to go after a negative number (e.g. `)`) - * posSuf // the string to go after a positive number - * }} pattern - * @param {string} groupSep The string to separate groups of number (e.g. `,`) - * @param {string} decimalSep The string to act as the decimal separator (e.g. `.`) - * @param {[type]} fractionSize The size of the fractional part of the number - * @return {string} The number formatted as a string - */ -function formatNumber(number, pattern, groupSep, decimalSep, fractionSize) { - - if (!(isString(number) || isNumber(number)) || isNaN(number)) return ''; - - var isInfinity = !isFinite(number); - var isZero = false; - var numStr = Math.abs(number) + '', - formattedText = '', - parsedNumber; - - if (isInfinity) { - formattedText = '\u221e'; - } else { - parsedNumber = parse(numStr); - - roundNumber(parsedNumber, fractionSize, pattern.minFrac, pattern.maxFrac); - - var digits = parsedNumber.d; - var integerLen = parsedNumber.i; - var exponent = parsedNumber.e; - var decimals = []; - isZero = digits.reduce(function(isZero, d) { return isZero && !d; }, true); - - // pad zeros for small numbers - while (integerLen < 0) { - digits.unshift(0); - integerLen++; - } - - // extract decimals digits - if (integerLen > 0) { - decimals = digits.splice(integerLen, digits.length); - } else { - decimals = digits; - digits = [0]; - } - - // format the integer digits with grouping separators - var groups = []; - if (digits.length >= pattern.lgSize) { - groups.unshift(digits.splice(-pattern.lgSize, digits.length).join('')); - } - while (digits.length > pattern.gSize) { - groups.unshift(digits.splice(-pattern.gSize, digits.length).join('')); - } - if (digits.length) { - groups.unshift(digits.join('')); - } - formattedText = groups.join(groupSep); - - // append the decimal digits - if (decimals.length) { - formattedText += decimalSep + decimals.join(''); - } - - if (exponent) { - formattedText += 'e+' + exponent; - } - } - if (number < 0 && !isZero) { - return pattern.negPre + formattedText + pattern.negSuf; - } else { - return pattern.posPre + formattedText + pattern.posSuf; - } -} - -function padNumber(num, digits, trim, negWrap) { - var neg = ''; - if (num < 0 || (negWrap && num <= 0)) { - if (negWrap) { - num = -num + 1; - } else { - num = -num; - neg = '-'; - } - } - num = '' + num; - while (num.length < digits) num = ZERO_CHAR + num; - if (trim) { - num = num.substr(num.length - digits); - } - return neg + num; -} - - -function dateGetter(name, size, offset, trim, negWrap) { - offset = offset || 0; - return function(date) { - var value = date['get' + name](); - if (offset > 0 || value > -offset) { - value += offset; - } - if (value === 0 && offset === -12) value = 12; - return padNumber(value, size, trim, negWrap); - }; -} - -function dateStrGetter(name, shortForm, standAlone) { - return function(date, formats) { - var value = date['get' + name](); - var propPrefix = (standAlone ? 'STANDALONE' : '') + (shortForm ? 'SHORT' : ''); - var get = uppercase(propPrefix + name); - - return formats[get][value]; - }; -} - -function timeZoneGetter(date, formats, offset) { - var zone = -1 * offset; - var paddedZone = (zone >= 0) ? '+' : ''; - - paddedZone += padNumber(Math[zone > 0 ? 'floor' : 'ceil'](zone / 60), 2) + - padNumber(Math.abs(zone % 60), 2); - - return paddedZone; -} - -function getFirstThursdayOfYear(year) { - // 0 = index of January - var dayOfWeekOnFirst = (new Date(year, 0, 1)).getDay(); - // 4 = index of Thursday (+1 to account for 1st = 5) - // 11 = index of *next* Thursday (+1 account for 1st = 12) - return new Date(year, 0, ((dayOfWeekOnFirst <= 4) ? 5 : 12) - dayOfWeekOnFirst); -} - -function getThursdayThisWeek(datetime) { - return new Date(datetime.getFullYear(), datetime.getMonth(), - // 4 = index of Thursday - datetime.getDate() + (4 - datetime.getDay())); -} - -function weekGetter(size) { - return function(date) { - var firstThurs = getFirstThursdayOfYear(date.getFullYear()), - thisThurs = getThursdayThisWeek(date); - - var diff = +thisThurs - +firstThurs, - result = 1 + Math.round(diff / 6.048e8); // 6.048e8 ms per week - - return padNumber(result, size); - }; -} - -function ampmGetter(date, formats) { - return date.getHours() < 12 ? formats.AMPMS[0] : formats.AMPMS[1]; -} - -function eraGetter(date, formats) { - return date.getFullYear() <= 0 ? formats.ERAS[0] : formats.ERAS[1]; -} - -function longEraGetter(date, formats) { - return date.getFullYear() <= 0 ? formats.ERANAMES[0] : formats.ERANAMES[1]; -} - -var DATE_FORMATS = { - yyyy: dateGetter('FullYear', 4, 0, false, true), - yy: dateGetter('FullYear', 2, 0, true, true), - y: dateGetter('FullYear', 1, 0, false, true), - MMMM: dateStrGetter('Month'), - MMM: dateStrGetter('Month', true), - MM: dateGetter('Month', 2, 1), - M: dateGetter('Month', 1, 1), - LLLL: dateStrGetter('Month', false, true), - dd: dateGetter('Date', 2), - d: dateGetter('Date', 1), - HH: dateGetter('Hours', 2), - H: dateGetter('Hours', 1), - hh: dateGetter('Hours', 2, -12), - h: dateGetter('Hours', 1, -12), - mm: dateGetter('Minutes', 2), - m: dateGetter('Minutes', 1), - ss: dateGetter('Seconds', 2), - s: dateGetter('Seconds', 1), - // while ISO 8601 requires fractions to be prefixed with `.` or `,` - // we can be just safely rely on using `sss` since we currently don't support single or two digit fractions - sss: dateGetter('Milliseconds', 3), - EEEE: dateStrGetter('Day'), - EEE: dateStrGetter('Day', true), - a: ampmGetter, - Z: timeZoneGetter, - ww: weekGetter(2), - w: weekGetter(1), - G: eraGetter, - GG: eraGetter, - GGG: eraGetter, - GGGG: longEraGetter -}; - -var DATE_FORMATS_SPLIT = /((?:[^yMLdHhmsaZEwG']+)|(?:'(?:[^']|'')*')|(?:E+|y+|M+|L+|d+|H+|h+|m+|s+|a|Z|G+|w+))(.*)/, - NUMBER_STRING = /^-?\d+$/; - -/** - * @ngdoc filter - * @name date - * @kind function - * - * @description - * Formats `date` to a string based on the requested `format`. - * - * `format` string can be composed of the following elements: - * - * * `'yyyy'`: 4 digit representation of year (e.g. AD 1 => 0001, AD 2010 => 2010) - * * `'yy'`: 2 digit representation of year, padded (00-99). (e.g. AD 2001 => 01, AD 2010 => 10) - * * `'y'`: 1 digit representation of year, e.g. (AD 1 => 1, AD 199 => 199) - * * `'MMMM'`: Month in year (January-December) - * * `'MMM'`: Month in year (Jan-Dec) - * * `'MM'`: Month in year, padded (01-12) - * * `'M'`: Month in year (1-12) - * * `'LLLL'`: Stand-alone month in year (January-December) - * * `'dd'`: Day in month, padded (01-31) - * * `'d'`: Day in month (1-31) - * * `'EEEE'`: Day in Week,(Sunday-Saturday) - * * `'EEE'`: Day in Week, (Sun-Sat) - * * `'HH'`: Hour in day, padded (00-23) - * * `'H'`: Hour in day (0-23) - * * `'hh'`: Hour in AM/PM, padded (01-12) - * * `'h'`: Hour in AM/PM, (1-12) - * * `'mm'`: Minute in hour, padded (00-59) - * * `'m'`: Minute in hour (0-59) - * * `'ss'`: Second in minute, padded (00-59) - * * `'s'`: Second in minute (0-59) - * * `'sss'`: Millisecond in second, padded (000-999) - * * `'a'`: AM/PM marker - * * `'Z'`: 4 digit (+sign) representation of the timezone offset (-1200-+1200) - * * `'ww'`: Week of year, padded (00-53). Week 01 is the week with the first Thursday of the year - * * `'w'`: Week of year (0-53). Week 1 is the week with the first Thursday of the year - * * `'G'`, `'GG'`, `'GGG'`: The abbreviated form of the era string (e.g. 'AD') - * * `'GGGG'`: The long form of the era string (e.g. 'Anno Domini') - * - * `format` string can also be one of the following predefined - * {@link guide/i18n localizable formats}: - * - * * `'medium'`: equivalent to `'MMM d, y h:mm:ss a'` for en_US locale - * (e.g. Sep 3, 2010 12:05:08 PM) - * * `'short'`: equivalent to `'M/d/yy h:mm a'` for en_US locale (e.g. 9/3/10 12:05 PM) - * * `'fullDate'`: equivalent to `'EEEE, MMMM d, y'` for en_US locale - * (e.g. Friday, September 3, 2010) - * * `'longDate'`: equivalent to `'MMMM d, y'` for en_US locale (e.g. September 3, 2010) - * * `'mediumDate'`: equivalent to `'MMM d, y'` for en_US locale (e.g. Sep 3, 2010) - * * `'shortDate'`: equivalent to `'M/d/yy'` for en_US locale (e.g. 9/3/10) - * * `'mediumTime'`: equivalent to `'h:mm:ss a'` for en_US locale (e.g. 12:05:08 PM) - * * `'shortTime'`: equivalent to `'h:mm a'` for en_US locale (e.g. 12:05 PM) - * - * `format` string can contain literal values. These need to be escaped by surrounding with single quotes (e.g. - * `"h 'in the morning'"`). In order to output a single quote, escape it - i.e., two single quotes in a sequence - * (e.g. `"h 'o''clock'"`). - * - * @param {(Date|number|string)} date Date to format either as Date object, milliseconds (string or - * number) or various ISO 8601 datetime string formats (e.g. yyyy-MM-ddTHH:mm:ss.sssZ and its - * shorter versions like yyyy-MM-ddTHH:mmZ, yyyy-MM-dd or yyyyMMddTHHmmssZ). If no timezone is - * specified in the string input, the time is considered to be in the local timezone. - * @param {string=} format Formatting rules (see Description). If not specified, - * `mediumDate` is used. - * @param {string=} timezone Timezone to be used for formatting. It understands UTC/GMT and the - * continental US time zone abbreviations, but for general use, use a time zone offset, for - * example, `'+0430'` (4 hours, 30 minutes east of the Greenwich meridian) - * If not specified, the timezone of the browser will be used. - * @returns {string} Formatted string or the input if input is not recognized as date/millis. - * - * @example - - - {{1288323623006 | date:'medium'}}: - {{1288323623006 | date:'medium'}}
- {{1288323623006 | date:'yyyy-MM-dd HH:mm:ss Z'}}: - {{1288323623006 | date:'yyyy-MM-dd HH:mm:ss Z'}}
- {{1288323623006 | date:'MM/dd/yyyy @ h:mma'}}: - {{'1288323623006' | date:'MM/dd/yyyy @ h:mma'}}
- {{1288323623006 | date:"MM/dd/yyyy 'at' h:mma"}}: - {{'1288323623006' | date:"MM/dd/yyyy 'at' h:mma"}}
- - - it('should format date', function() { - expect(element(by.binding("1288323623006 | date:'medium'")).getText()). - toMatch(/Oct 2\d, 2010 \d{1,2}:\d{2}:\d{2} (AM|PM)/); - expect(element(by.binding("1288323623006 | date:'yyyy-MM-dd HH:mm:ss Z'")).getText()). - toMatch(/2010-10-2\d \d{2}:\d{2}:\d{2} (-|\+)?\d{4}/); - expect(element(by.binding("'1288323623006' | date:'MM/dd/yyyy @ h:mma'")).getText()). - toMatch(/10\/2\d\/2010 @ \d{1,2}:\d{2}(AM|PM)/); - expect(element(by.binding("'1288323623006' | date:\"MM/dd/yyyy 'at' h:mma\"")).getText()). - toMatch(/10\/2\d\/2010 at \d{1,2}:\d{2}(AM|PM)/); - }); - - - */ -dateFilter.$inject = ['$locale']; -function dateFilter($locale) { - - - var R_ISO8601_STR = /^(\d{4})-?(\d\d)-?(\d\d)(?:T(\d\d)(?::?(\d\d)(?::?(\d\d)(?:\.(\d+))?)?)?(Z|([+-])(\d\d):?(\d\d))?)?$/; - // 1 2 3 4 5 6 7 8 9 10 11 - function jsonStringToDate(string) { - var match; - if ((match = string.match(R_ISO8601_STR))) { - var date = new Date(0), - tzHour = 0, - tzMin = 0, - dateSetter = match[8] ? date.setUTCFullYear : date.setFullYear, - timeSetter = match[8] ? date.setUTCHours : date.setHours; - - if (match[9]) { - tzHour = toInt(match[9] + match[10]); - tzMin = toInt(match[9] + match[11]); - } - dateSetter.call(date, toInt(match[1]), toInt(match[2]) - 1, toInt(match[3])); - var h = toInt(match[4] || 0) - tzHour; - var m = toInt(match[5] || 0) - tzMin; - var s = toInt(match[6] || 0); - var ms = Math.round(parseFloat('0.' + (match[7] || 0)) * 1000); - timeSetter.call(date, h, m, s, ms); - return date; - } - return string; - } - - - return function(date, format, timezone) { - var text = '', - parts = [], - fn, match; - - format = format || 'mediumDate'; - format = $locale.DATETIME_FORMATS[format] || format; - if (isString(date)) { - date = NUMBER_STRING.test(date) ? toInt(date) : jsonStringToDate(date); - } - - if (isNumber(date)) { - date = new Date(date); - } - - if (!isDate(date) || !isFinite(date.getTime())) { - return date; - } - - while (format) { - match = DATE_FORMATS_SPLIT.exec(format); - if (match) { - parts = concat(parts, match, 1); - format = parts.pop(); - } else { - parts.push(format); - format = null; - } - } - - var dateTimezoneOffset = date.getTimezoneOffset(); - if (timezone) { - dateTimezoneOffset = timezoneToOffset(timezone, dateTimezoneOffset); - date = convertTimezoneToLocal(date, timezone, true); - } - forEach(parts, function(value) { - fn = DATE_FORMATS[value]; - text += fn ? fn(date, $locale.DATETIME_FORMATS, dateTimezoneOffset) - : value === '\'\'' ? '\'' : value.replace(/(^'|'$)/g, '').replace(/''/g, '\''); - }); - - return text; - }; -} - - -/** - * @ngdoc filter - * @name json - * @kind function - * - * @description - * Allows you to convert a JavaScript object into JSON string. - * - * This filter is mostly useful for debugging. When using the double curly {{value}} notation - * the binding is automatically converted to JSON. - * - * @param {*} object Any JavaScript object (including arrays and primitive types) to filter. - * @param {number=} spacing The number of spaces to use per indentation, defaults to 2. - * @returns {string} JSON string. - * - * - * @example - - - 
{{ {'name':'value'} | json }}
- 
{{ {'name':'value'} | json:4 }}
- - - it('should jsonify filtered objects', function() { - expect(element(by.id('default-spacing')).getText()).toMatch(/\{\n {2}"name": ?"value"\n}/); - expect(element(by.id('custom-spacing')).getText()).toMatch(/\{\n {4}"name": ?"value"\n}/); - }); - - - * - */ -function jsonFilter() { - return function(object, spacing) { - if (isUndefined(spacing)) { - spacing = 2; - } - return toJson(object, spacing); - }; -} - - -/** - * @ngdoc filter - * @name lowercase - * @kind function - * @description - * Converts string to lowercase. - * @see angular.lowercase - */ -var lowercaseFilter = valueFn(lowercase); - - -/** - * @ngdoc filter - * @name uppercase - * @kind function - * @description - * Converts string to uppercase. - * @see angular.uppercase - */ -var uppercaseFilter = valueFn(uppercase); - -/** - * @ngdoc filter - * @name limitTo - * @kind function - * - * @description - * Creates a new array or string containing only a specified number of elements. The elements are - * taken from either the beginning or the end of the source array, string or number, as specified by - * the value and sign (positive or negative) of `limit`. Other array-like objects are also supported - * (e.g. array subclasses, NodeLists, jqLite/jQuery collections etc). If a number is used as input, - * it is converted to a string. - * - * @param {Array|ArrayLike|string|number} input - Array/array-like, string or number to be limited. - * @param {string|number} limit - The length of the returned array or string. If the `limit` number - * is positive, `limit` number of items from the beginning of the source array/string are copied. - * If the number is negative, `limit` number of items from the end of the source array/string - * are copied. The `limit` will be trimmed if it exceeds `array.length`. If `limit` is undefined, - * the input will be returned unchanged. - * @param {(string|number)=} begin - Index at which to begin limitation. As a negative index, - * `begin` indicates an offset from the end of `input`. Defaults to `0`. - * @returns {Array|string} A new sub-array or substring of length `limit` or less if the input had - * less than `limit` elements. - * - * @example - - - -
- -

Output numbers: {{ numbers | limitTo:numLimit }}

- -

Output letters: {{ letters | limitTo:letterLimit }}

- -

Output long number: {{ longNumber | limitTo:longNumberLimit }}

-
- - - var numLimitInput = element(by.model('numLimit')); - var letterLimitInput = element(by.model('letterLimit')); - var longNumberLimitInput = element(by.model('longNumberLimit')); - var limitedNumbers = element(by.binding('numbers | limitTo:numLimit')); - var limitedLetters = element(by.binding('letters | limitTo:letterLimit')); - var limitedLongNumber = element(by.binding('longNumber | limitTo:longNumberLimit')); - - it('should limit the number array to first three items', function() { - expect(numLimitInput.getAttribute('value')).toBe('3'); - expect(letterLimitInput.getAttribute('value')).toBe('3'); - expect(longNumberLimitInput.getAttribute('value')).toBe('3'); - expect(limitedNumbers.getText()).toEqual('Output numbers: [1,2,3]'); - expect(limitedLetters.getText()).toEqual('Output letters: abc'); - expect(limitedLongNumber.getText()).toEqual('Output long number: 234'); - }); - - // There is a bug in safari and protractor that doesn't like the minus key - // it('should update the output when -3 is entered', function() { - // numLimitInput.clear(); - // numLimitInput.sendKeys('-3'); - // letterLimitInput.clear(); - // letterLimitInput.sendKeys('-3'); - // longNumberLimitInput.clear(); - // longNumberLimitInput.sendKeys('-3'); - // expect(limitedNumbers.getText()).toEqual('Output numbers: [7,8,9]'); - // expect(limitedLetters.getText()).toEqual('Output letters: ghi'); - // expect(limitedLongNumber.getText()).toEqual('Output long number: 342'); - // }); - - it('should not exceed the maximum size of input array', function() { - numLimitInput.clear(); - numLimitInput.sendKeys('100'); - letterLimitInput.clear(); - letterLimitInput.sendKeys('100'); - longNumberLimitInput.clear(); - longNumberLimitInput.sendKeys('100'); - expect(limitedNumbers.getText()).toEqual('Output numbers: [1,2,3,4,5,6,7,8,9]'); - expect(limitedLetters.getText()).toEqual('Output letters: abcdefghi'); - expect(limitedLongNumber.getText()).toEqual('Output long number: 2345432342'); - }); - - -*/ -function limitToFilter() { - return function(input, limit, begin) { - if (Math.abs(Number(limit)) === Infinity) { - limit = Number(limit); - } else { - limit = toInt(limit); - } - if (isNumberNaN(limit)) return input; - - if (isNumber(input)) input = input.toString(); - if (!isArrayLike(input)) return input; - - begin = (!begin || isNaN(begin)) ? 0 : toInt(begin); - begin = (begin < 0) ? Math.max(0, input.length + begin) : begin; - - if (limit >= 0) { - return sliceFn(input, begin, begin + limit); - } else { - if (begin === 0) { - return sliceFn(input, limit, input.length); - } else { - return sliceFn(input, Math.max(0, begin + limit), begin); - } - } - }; -} - -function sliceFn(input, begin, end) { - if (isString(input)) return input.slice(begin, end); - - return slice.call(input, begin, end); -} - -/** - * @ngdoc filter - * @name orderBy - * @kind function - * - * @description - * Returns an array containing the items from the specified `collection`, ordered by a `comparator` - * function based on the values computed using the `expression` predicate. - * - * For example, `[{id: 'foo'}, {id: 'bar'}] | orderBy:'id'` would result in - * `[{id: 'bar'}, {id: 'foo'}]`. - * - * The `collection` can be an Array or array-like object (e.g. NodeList, jQuery object, TypedArray, - * String, etc). - * - * The `expression` can be a single predicate, or a list of predicates each serving as a tie-breaker - * for the preceding one. The `expression` is evaluated against each item and the output is used - * for comparing with other items. - * - * You can change the sorting order by setting `reverse` to `true`. By default, items are sorted in - * ascending order. - * - * The comparison is done using the `comparator` function. If none is specified, a default, built-in - * comparator is used (see below for details - in a nutshell, it compares numbers numerically and - * strings alphabetically). - * - * ### Under the hood - * - * Ordering the specified `collection` happens in two phases: - * - * 1. All items are passed through the predicate (or predicates), and the returned values are saved - * along with their type (`string`, `number` etc). For example, an item `{label: 'foo'}`, passed - * through a predicate that extracts the value of the `label` property, would be transformed to: - * ``` - * { - * value: 'foo', - * type: 'string', - * index: ... - * } - * ``` - * 2. The comparator function is used to sort the items, based on the derived values, types and - * indices. - * - * If you use a custom comparator, it will be called with pairs of objects of the form - * `{value: ..., type: '...', index: ...}` and is expected to return `0` if the objects are equal - * (as far as the comparator is concerned), `-1` if the 1st one should be ranked higher than the - * second, or `1` otherwise. - * - * In order to ensure that the sorting will be deterministic across platforms, if none of the - * specified predicates can distinguish between two items, `orderBy` will automatically introduce a - * dummy predicate that returns the item's index as `value`. - * (If you are using a custom comparator, make sure it can handle this predicate as well.) - * - * Finally, in an attempt to simplify things, if a predicate returns an object as the extracted - * value for an item, `orderBy` will try to convert that object to a primitive value, before passing - * it to the comparator. The following rules govern the conversion: - * - * 1. If the object has a `valueOf()` method that returns a primitive, its return value will be - * used instead.
- * (If the object has a `valueOf()` method that returns another object, then the returned object - * will be used in subsequent steps.) - * 2. If the object has a custom `toString()` method (i.e. not the one inherited from `Object`) that - * returns a primitive, its return value will be used instead.
- * (If the object has a `toString()` method that returns another object, then the returned object - * will be used in subsequent steps.) - * 3. No conversion; the object itself is used. - * - * ### The default comparator - * - * The default, built-in comparator should be sufficient for most usecases. In short, it compares - * numbers numerically, strings alphabetically (and case-insensitively), for objects falls back to - * using their index in the original collection, and sorts values of different types by type. - * - * More specifically, it follows these steps to determine the relative order of items: - * - * 1. If the compared values are of different types, compare the types themselves alphabetically. - * 2. If both values are of type `string`, compare them alphabetically in a case- and - * locale-insensitive way. - * 3. If both values are objects, compare their indices instead. - * 4. Otherwise, return: - * - `0`, if the values are equal (by strict equality comparison, i.e. using `===`). - * - `-1`, if the 1st value is "less than" the 2nd value (compared using the `<` operator). - * - `1`, otherwise. - * - * **Note:** If you notice numbers not being sorted as expected, make sure they are actually being - * saved as numbers and not strings. - * **Note:** For the purpose of sorting, `null` values are treated as the string `'null'` (i.e. - * `type: 'string'`, `value: 'null'`). This may cause unexpected sort order relative to - * other values. - * - * @param {Array|ArrayLike} collection - The collection (array or array-like object) to sort. - * @param {(Function|string|Array.)=} expression - A predicate (or list of - * predicates) to be used by the comparator to determine the order of elements. - * - * Can be one of: - * - * - `Function`: A getter function. This function will be called with each item as argument and - * the return value will be used for sorting. - * - `string`: An Angular expression. This expression will be evaluated against each item and the - * result will be used for sorting. For example, use `'label'` to sort by a property called - * `label` or `'label.substring(0, 3)'` to sort by the first 3 characters of the `label` - * property.
- * (The result of a constant expression is interpreted as a property name to be used for - * comparison. For example, use `'"special name"'` (note the extra pair of quotes) to sort by a - * property called `special name`.)
- * An expression can be optionally prefixed with `+` or `-` to control the sorting direction, - * ascending or descending. For example, `'+label'` or `'-label'`. If no property is provided, - * (e.g. `'+'` or `'-'`), the collection element itself is used in comparisons. - * - `Array`: An array of function and/or string predicates. If a predicate cannot determine the - * relative order of two items, the next predicate is used as a tie-breaker. - * - * **Note:** If the predicate is missing or empty then it defaults to `'+'`. - * - * @param {boolean=} reverse - If `true`, reverse the sorting order. - * @param {(Function)=} comparator - The comparator function used to determine the relative order of - * value pairs. If omitted, the built-in comparator will be used. - * - * @returns {Array} - The sorted array. - * - * - * @example - * ### Ordering a table with `ngRepeat` - * - * The example below demonstrates a simple {@link ngRepeat ngRepeat}, where the data is sorted by - * age in descending order (expression is set to `'-age'`). The `comparator` is not set, which means - * it defaults to the built-in comparator. - * - - -
- - - - - - - - - - - -
NamePhone NumberAge
{{friend.name}}{{friend.phone}}{{friend.age}}
-
- - - angular.module('orderByExample1', []) - .controller('ExampleController', ['$scope', function($scope) { - $scope.friends = [ - {name: 'John', phone: '555-1212', age: 10}, - {name: 'Mary', phone: '555-9876', age: 19}, - {name: 'Mike', phone: '555-4321', age: 21}, - {name: 'Adam', phone: '555-5678', age: 35}, - {name: 'Julie', phone: '555-8765', age: 29} - ]; - }]); - - - .friends { - border-collapse: collapse; - } - - .friends th { - border-bottom: 1px solid; - } - .friends td, .friends th { - border-left: 1px solid; - padding: 5px 10px; - } - .friends td:first-child, .friends th:first-child { - border-left: none; - } - - - // Element locators - var names = element.all(by.repeater('friends').column('friend.name')); - - it('should sort friends by age in reverse order', function() { - expect(names.get(0).getText()).toBe('Adam'); - expect(names.get(1).getText()).toBe('Julie'); - expect(names.get(2).getText()).toBe('Mike'); - expect(names.get(3).getText()).toBe('Mary'); - expect(names.get(4).getText()).toBe('John'); - }); - - - *
- * - * @example - * ### Changing parameters dynamically - * - * All parameters can be changed dynamically. The next example shows how you can make the columns of - * a table sortable, by binding the `expression` and `reverse` parameters to scope properties. - * - - -
- 
Sort by = {{propertyName}}; reverse = {{reverse}}
-
- -
- - - - - - - - - - - -
- - - - - - - - -
{{friend.name}}{{friend.phone}}{{friend.age}}
-
- - - angular.module('orderByExample2', []) - .controller('ExampleController', ['$scope', function($scope) { - var friends = [ - {name: 'John', phone: '555-1212', age: 10}, - {name: 'Mary', phone: '555-9876', age: 19}, - {name: 'Mike', phone: '555-4321', age: 21}, - {name: 'Adam', phone: '555-5678', age: 35}, - {name: 'Julie', phone: '555-8765', age: 29} - ]; - - $scope.propertyName = 'age'; - $scope.reverse = true; - $scope.friends = friends; - - $scope.sortBy = function(propertyName) { - $scope.reverse = ($scope.propertyName === propertyName) ? !$scope.reverse : false; - $scope.propertyName = propertyName; - }; - }]); - - - .friends { - border-collapse: collapse; - } - - .friends th { - border-bottom: 1px solid; - } - .friends td, .friends th { - border-left: 1px solid; - padding: 5px 10px; - } - .friends td:first-child, .friends th:first-child { - border-left: none; - } - - .sortorder:after { - content: '\25b2'; // BLACK UP-POINTING TRIANGLE - } - .sortorder.reverse:after { - content: '\25bc'; // BLACK DOWN-POINTING TRIANGLE - } - - - // Element locators - var unsortButton = element(by.partialButtonText('unsorted')); - var nameHeader = element(by.partialButtonText('Name')); - var phoneHeader = element(by.partialButtonText('Phone')); - var ageHeader = element(by.partialButtonText('Age')); - var firstName = element(by.repeater('friends').column('friend.name').row(0)); - var lastName = element(by.repeater('friends').column('friend.name').row(4)); - - it('should sort friends by some property, when clicking on the column header', function() { - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - - phoneHeader.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Mary'); - - nameHeader.click(); - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('Mike'); - - ageHeader.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Adam'); - }); - - it('should sort friends in reverse order, when clicking on the same column', function() { - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - - ageHeader.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Adam'); - - ageHeader.click(); - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - }); - - it('should restore the original order, when clicking "Set to unsorted"', function() { - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - - unsortButton.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Julie'); - }); - - - *
- * - * @example - * ### Using `orderBy` inside a controller - * - * It is also possible to call the `orderBy` filter manually, by injecting `orderByFilter`, and - * calling it with the desired parameters. (Alternatively, you could inject the `$filter` factory - * and retrieve the `orderBy` filter with `$filter('orderBy')`.) - * - - -
- 
Sort by = {{propertyName}}; reverse = {{reverse}}
-
- -
- - - - - - - - - - - -
- - - - - - - - -
{{friend.name}}{{friend.phone}}{{friend.age}}
-
- - - angular.module('orderByExample3', []) - .controller('ExampleController', ['$scope', 'orderByFilter', function($scope, orderBy) { - var friends = [ - {name: 'John', phone: '555-1212', age: 10}, - {name: 'Mary', phone: '555-9876', age: 19}, - {name: 'Mike', phone: '555-4321', age: 21}, - {name: 'Adam', phone: '555-5678', age: 35}, - {name: 'Julie', phone: '555-8765', age: 29} - ]; - - $scope.propertyName = 'age'; - $scope.reverse = true; - $scope.friends = orderBy(friends, $scope.propertyName, $scope.reverse); - - $scope.sortBy = function(propertyName) { - $scope.reverse = (propertyName !== null && $scope.propertyName === propertyName) - ? !$scope.reverse : false; - $scope.propertyName = propertyName; - $scope.friends = orderBy(friends, $scope.propertyName, $scope.reverse); - }; - }]); - - - .friends { - border-collapse: collapse; - } - - .friends th { - border-bottom: 1px solid; - } - .friends td, .friends th { - border-left: 1px solid; - padding: 5px 10px; - } - .friends td:first-child, .friends th:first-child { - border-left: none; - } - - .sortorder:after { - content: '\25b2'; // BLACK UP-POINTING TRIANGLE - } - .sortorder.reverse:after { - content: '\25bc'; // BLACK DOWN-POINTING TRIANGLE - } - - - // Element locators - var unsortButton = element(by.partialButtonText('unsorted')); - var nameHeader = element(by.partialButtonText('Name')); - var phoneHeader = element(by.partialButtonText('Phone')); - var ageHeader = element(by.partialButtonText('Age')); - var firstName = element(by.repeater('friends').column('friend.name').row(0)); - var lastName = element(by.repeater('friends').column('friend.name').row(4)); - - it('should sort friends by some property, when clicking on the column header', function() { - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - - phoneHeader.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Mary'); - - nameHeader.click(); - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('Mike'); - - ageHeader.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Adam'); - }); - - it('should sort friends in reverse order, when clicking on the same column', function() { - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - - ageHeader.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Adam'); - - ageHeader.click(); - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - }); - - it('should restore the original order, when clicking "Set to unsorted"', function() { - expect(firstName.getText()).toBe('Adam'); - expect(lastName.getText()).toBe('John'); - - unsortButton.click(); - expect(firstName.getText()).toBe('John'); - expect(lastName.getText()).toBe('Julie'); - }); - - - *
- * - * @example - * ### Using a custom comparator - * - * If you have very specific requirements about the way items are sorted, you can pass your own - * comparator function. For example, you might need to compare some strings in a locale-sensitive - * way. (When specifying a custom comparator, you also need to pass a value for the `reverse` - * argument - passing `false` retains the default sorting order, i.e. ascending.) - * - - -
-
-

Locale-sensitive Comparator

- - - - - - - - - -
NameFavorite Letter
{{friend.name}}{{friend.favoriteLetter}}
-
-
-

Default Comparator

- - - - - - - - - -
NameFavorite Letter
{{friend.name}}{{friend.favoriteLetter}}
-
-
- - - angular.module('orderByExample4', []) - .controller('ExampleController', ['$scope', function($scope) { - $scope.friends = [ - {name: 'John', favoriteLetter: 'Ä'}, - {name: 'Mary', favoriteLetter: 'Ü'}, - {name: 'Mike', favoriteLetter: 'Ö'}, - {name: 'Adam', favoriteLetter: 'H'}, - {name: 'Julie', favoriteLetter: 'Z'} - ]; - - $scope.localeSensitiveComparator = function(v1, v2) { - // If we don't get strings, just compare by index - if (v1.type !== 'string' || v2.type !== 'string') { - return (v1.index < v2.index) ? -1 : 1; - } - - // Compare strings alphabetically, taking locale into account - return v1.value.localeCompare(v2.value); - }; - }]); - - - .friends-container { - display: inline-block; - margin: 0 30px; - } - - .friends { - border-collapse: collapse; - } - - .friends th { - border-bottom: 1px solid; - } - .friends td, .friends th { - border-left: 1px solid; - padding: 5px 10px; - } - .friends td:first-child, .friends th:first-child { - border-left: none; - } - - - // Element locators - var container = element(by.css('.custom-comparator')); - var names = container.all(by.repeater('friends').column('friend.name')); - - it('should sort friends by favorite letter (in correct alphabetical order)', function() { - expect(names.get(0).getText()).toBe('John'); - expect(names.get(1).getText()).toBe('Adam'); - expect(names.get(2).getText()).toBe('Mike'); - expect(names.get(3).getText()).toBe('Mary'); - expect(names.get(4).getText()).toBe('Julie'); - }); - - - * - */ -orderByFilter.$inject = ['$parse']; -function orderByFilter($parse) { - return function(array, sortPredicate, reverseOrder, compareFn) { - - if (array == null) return array; - if (!isArrayLike(array)) { - throw minErr('orderBy')('notarray', 'Expected array but received: {0}', array); - } - - if (!isArray(sortPredicate)) { sortPredicate = [sortPredicate]; } - if (sortPredicate.length === 0) { sortPredicate = ['+']; } - - var predicates = processPredicates(sortPredicate); - - var descending = reverseOrder ? -1 : 1; - - // Define the `compare()` function. Use a default comparator if none is specified. - var compare = isFunction(compareFn) ? compareFn : defaultCompare; - - // The next three lines are a version of a Swartzian Transform idiom from Perl - // (sometimes called the Decorate-Sort-Undecorate idiom) - // See https://en.wikipedia.org/wiki/Schwartzian_transform - var compareValues = Array.prototype.map.call(array, getComparisonObject); - compareValues.sort(doComparison); - array = compareValues.map(function(item) { return item.value; }); - - return array; - - function getComparisonObject(value, index) { - // NOTE: We are adding an extra `tieBreaker` value based on the element's index. - // This will be used to keep the sort stable when none of the input predicates can - // distinguish between two elements. - return { - value: value, - tieBreaker: {value: index, type: 'number', index: index}, - predicateValues: predicates.map(function(predicate) { - return getPredicateValue(predicate.get(value), index); - }) - }; - } - - function doComparison(v1, v2) { - for (var i = 0, ii = predicates.length; i < ii; i++) { - var result = compare(v1.predicateValues[i], v2.predicateValues[i]); - if (result) { - return result * predicates[i].descending * descending; - } - } - - return compare(v1.tieBreaker, v2.tieBreaker) * descending; - } - }; - - function processPredicates(sortPredicates) { - return sortPredicates.map(function(predicate) { - var descending = 1, get = identity; - - if (isFunction(predicate)) { - get = predicate; - } else if (isString(predicate)) { - if ((predicate.charAt(0) === '+' || predicate.charAt(0) === '-')) { - descending = predicate.charAt(0) === '-' ? -1 : 1; - predicate = predicate.substring(1); - } - if (predicate !== '') { - get = $parse(predicate); - if (get.constant) { - var key = get(); - get = function(value) { return value[key]; }; - } - } - } - return {get: get, descending: descending}; - }); - } - - function isPrimitive(value) { - switch (typeof value) { - case 'number': /* falls through */ - case 'boolean': /* falls through */ - case 'string': - return true; - default: - return false; - } - } - - function objectValue(value) { - // If `valueOf` is a valid function use that - if (isFunction(value.valueOf)) { - value = value.valueOf(); - if (isPrimitive(value)) return value; - } - // If `toString` is a valid function and not the one from `Object.prototype` use that - if (hasCustomToString(value)) { - value = value.toString(); - if (isPrimitive(value)) return value; - } - - return value; - } - - function getPredicateValue(value, index) { - var type = typeof value; - if (value === null) { - type = 'string'; - value = 'null'; - } else if (type === 'object') { - value = objectValue(value); - } - return {value: value, type: type, index: index}; - } - - function defaultCompare(v1, v2) { - var result = 0; - var type1 = v1.type; - var type2 = v2.type; - - if (type1 === type2) { - var value1 = v1.value; - var value2 = v2.value; - - if (type1 === 'string') { - // Compare strings case-insensitively - value1 = value1.toLowerCase(); - value2 = value2.toLowerCase(); - } else if (type1 === 'object') { - // For basic objects, use the position of the object - // in the collection instead of the value - if (isObject(value1)) value1 = v1.index; - if (isObject(value2)) value2 = v2.index; - } - - if (value1 !== value2) { - result = value1 < value2 ? -1 : 1; - } - } else { - result = type1 < type2 ? -1 : 1; - } - - return result; - } -} - -function ngDirective(directive) { - if (isFunction(directive)) { - directive = { - link: directive - }; - } - directive.restrict = directive.restrict || 'AC'; - return valueFn(directive); -} - -/** - * @ngdoc directive - * @name a - * @restrict E - * - * @description - * Modifies the default behavior of the html a tag so that the default action is prevented when - * the href attribute is empty. - * - * For dynamically creating `href` attributes for a tags, see the {@link ng.ngHref `ngHref`} directive. - */ -var htmlAnchorDirective = valueFn({ - restrict: 'E', - compile: function(element, attr) { - if (!attr.href && !attr.xlinkHref) { - return function(scope, element) { - // If the linked element is not an anchor tag anymore, do nothing - if (element[0].nodeName.toLowerCase() !== 'a') return; - - // SVGAElement does not use the href attribute, but rather the 'xlinkHref' attribute. - var href = toString.call(element.prop('href')) === '[object SVGAnimatedString]' ? - 'xlink:href' : 'href'; - element.on('click', function(event) { - // if we have no href url, then don't navigate anywhere. - if (!element.attr(href)) { - event.preventDefault(); - } - }); - }; - } - } -}); - -/** - * @ngdoc directive - * @name ngHref - * @restrict A - * @priority 99 - * - * @description - * Using Angular markup like `{{hash}}` in an href attribute will - * make the link go to the wrong URL if the user clicks it before - * Angular has a chance to replace the `{{hash}}` markup with its - * value. Until Angular replaces the markup the link will be broken - * and will most likely return a 404 error. The `ngHref` directive - * solves this problem. - * - * The wrong way to write it: - * ```html - * link1 - * ``` - * - * The correct way to write it: - * ```html - * link1 - * ``` - * - * @element A - * @param {template} ngHref any string which can contain `{{}}` markup. - * - * @example - * This example shows various combinations of `href`, `ng-href` and `ng-click` attributes - * in links and their different behaviors: - - -
- link 1 (link, don't reload)
- link 2 (link, don't reload)
- link 3 (link, reload!)
- anchor (link, don't reload)
- anchor (no link)
- link (link, change location) - - - it('should execute ng-click but not reload when href without value', function() { - element(by.id('link-1')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('1'); - expect(element(by.id('link-1')).getAttribute('href')).toBe(''); - }); - - it('should execute ng-click but not reload when href empty string', function() { - element(by.id('link-2')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('2'); - expect(element(by.id('link-2')).getAttribute('href')).toBe(''); - }); - - it('should execute ng-click and change url when ng-href specified', function() { - expect(element(by.id('link-3')).getAttribute('href')).toMatch(/\/123$/); - - element(by.id('link-3')).click(); - - // At this point, we navigate away from an Angular page, so we need - // to use browser.driver to get the base webdriver. - - browser.wait(function() { - return browser.driver.getCurrentUrl().then(function(url) { - return url.match(/\/123$/); - }); - }, 5000, 'page should navigate to /123'); - }); - - it('should execute ng-click but not reload when href empty string and name specified', function() { - element(by.id('link-4')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('4'); - expect(element(by.id('link-4')).getAttribute('href')).toBe(''); - }); - - it('should execute ng-click but not reload when no href but name specified', function() { - element(by.id('link-5')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('5'); - expect(element(by.id('link-5')).getAttribute('href')).toBe(null); - }); - - it('should only change url when only ng-href', function() { - element(by.model('value')).clear(); - element(by.model('value')).sendKeys('6'); - expect(element(by.id('link-6')).getAttribute('href')).toMatch(/\/6$/); - - element(by.id('link-6')).click(); - - // At this point, we navigate away from an Angular page, so we need - // to use browser.driver to get the base webdriver. - browser.wait(function() { - return browser.driver.getCurrentUrl().then(function(url) { - return url.match(/\/6$/); - }); - }, 5000, 'page should navigate to /6'); - }); - - - */ - -/** - * @ngdoc directive - * @name ngSrc - * @restrict A - * @priority 99 - * - * @description - * Using Angular markup like `{{hash}}` in a `src` attribute doesn't - * work right: The browser will fetch from the URL with the literal - * text `{{hash}}` until Angular replaces the expression inside - * `{{hash}}`. The `ngSrc` directive solves this problem. - * - * The buggy way to write it: - * ```html - * Description - * ``` - * - * The correct way to write it: - * ```html - * Description - * ``` - * - * @element IMG - * @param {template} ngSrc any string which can contain `{{}}` markup. - */ - -/** - * @ngdoc directive - * @name ngSrcset - * @restrict A - * @priority 99 - * - * @description - * Using Angular markup like `{{hash}}` in a `srcset` attribute doesn't - * work right: The browser will fetch from the URL with the literal - * text `{{hash}}` until Angular replaces the expression inside - * `{{hash}}`. The `ngSrcset` directive solves this problem. - * - * The buggy way to write it: - * ```html - * Description - * ``` - * - * The correct way to write it: - * ```html - * Description - * ``` - * - * @element IMG - * @param {template} ngSrcset any string which can contain `{{}}` markup. - */ - -/** - * @ngdoc directive - * @name ngDisabled - * @restrict A - * @priority 100 - * - * @description - * - * This directive sets the `disabled` attribute on the element if the - * {@link guide/expression expression} inside `ngDisabled` evaluates to truthy. - * - * A special directive is necessary because we cannot use interpolation inside the `disabled` - * attribute. See the {@link guide/interpolation interpolation guide} for more info. - * - * @example - - -
- - - - it('should toggle button', function() { - expect(element(by.css('button')).getAttribute('disabled')).toBeFalsy(); - element(by.model('checked')).click(); - expect(element(by.css('button')).getAttribute('disabled')).toBeTruthy(); - }); - - - * - * @element INPUT - * @param {expression} ngDisabled If the {@link guide/expression expression} is truthy, - * then the `disabled` attribute will be set on the element - */ - - -/** - * @ngdoc directive - * @name ngChecked - * @restrict A - * @priority 100 - * - * @description - * Sets the `checked` attribute on the element, if the expression inside `ngChecked` is truthy. - * - * Note that this directive should not be used together with {@link ngModel `ngModel`}, - * as this can lead to unexpected behavior. - * - * A special directive is necessary because we cannot use interpolation inside the `checked` - * attribute. See the {@link guide/interpolation interpolation guide} for more info. - * - * @example - - -
- - - - it('should check both checkBoxes', function() { - expect(element(by.id('checkSlave')).getAttribute('checked')).toBeFalsy(); - element(by.model('master')).click(); - expect(element(by.id('checkSlave')).getAttribute('checked')).toBeTruthy(); - }); - - - * - * @element INPUT - * @param {expression} ngChecked If the {@link guide/expression expression} is truthy, - * then the `checked` attribute will be set on the element - */ - - -/** - * @ngdoc directive - * @name ngReadonly - * @restrict A - * @priority 100 - * - * @description - * - * Sets the `readonly` attribute on the element, if the expression inside `ngReadonly` is truthy. - * Note that `readonly` applies only to `input` elements with specific types. [See the input docs on - * MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly) for more information. - * - * A special directive is necessary because we cannot use interpolation inside the `readonly` - * attribute. See the {@link guide/interpolation interpolation guide} for more info. - * - * @example - - -
- - - - it('should toggle readonly attr', function() { - expect(element(by.css('[type="text"]')).getAttribute('readonly')).toBeFalsy(); - element(by.model('checked')).click(); - expect(element(by.css('[type="text"]')).getAttribute('readonly')).toBeTruthy(); - }); - - - * - * @element INPUT - * @param {expression} ngReadonly If the {@link guide/expression expression} is truthy, - * then special attribute "readonly" will be set on the element - */ - - -/** - * @ngdoc directive - * @name ngSelected - * @restrict A - * @priority 100 - * - * @description - * - * Sets the `selected` attribute on the element, if the expression inside `ngSelected` is truthy. - * - * A special directive is necessary because we cannot use interpolation inside the `selected` - * attribute. See the {@link guide/interpolation interpolation guide} for more info. - * - *
- * **Note:** `ngSelected` does not interact with the `select` and `ngModel` directives, it only - * sets the `selected` attribute on the element. If you are using `ngModel` on the select, you - * should not use `ngSelected` on the options, as `ngModel` will set the select value and - * selected options. - *
- * - * @example - - -
- - - - it('should select Greetings!', function() { - expect(element(by.id('greet')).getAttribute('selected')).toBeFalsy(); - element(by.model('selected')).click(); - expect(element(by.id('greet')).getAttribute('selected')).toBeTruthy(); - }); - - - * - * @element OPTION - * @param {expression} ngSelected If the {@link guide/expression expression} is truthy, - * then special attribute "selected" will be set on the element - */ - -/** - * @ngdoc directive - * @name ngOpen - * @restrict A - * @priority 100 - * - * @description - * - * Sets the `open` attribute on the element, if the expression inside `ngOpen` is truthy. - * - * A special directive is necessary because we cannot use interpolation inside the `open` - * attribute. See the {@link guide/interpolation interpolation guide} for more info. - * - * ## A note about browser compatibility - * - * Edge, Firefox, and Internet Explorer do not support the `details` element, it is - * recommended to use {@link ng.ngShow} and {@link ng.ngHide} instead. - * - * @example - - -
-
- Show/Hide me -
- - - it('should toggle open', function() { - expect(element(by.id('details')).getAttribute('open')).toBeFalsy(); - element(by.model('open')).click(); - expect(element(by.id('details')).getAttribute('open')).toBeTruthy(); - }); - - - * - * @element DETAILS - * @param {expression} ngOpen If the {@link guide/expression expression} is truthy, - * then special attribute "open" will be set on the element - */ - -var ngAttributeAliasDirectives = {}; - -// boolean attrs are evaluated -forEach(BOOLEAN_ATTR, function(propName, attrName) { - // binding to multiple is not supported - if (propName === 'multiple') return; - - function defaultLinkFn(scope, element, attr) { - scope.$watch(attr[normalized], function ngBooleanAttrWatchAction(value) { - attr.$set(attrName, !!value); - }); - } - - var normalized = directiveNormalize('ng-' + attrName); - var linkFn = defaultLinkFn; - - if (propName === 'checked') { - linkFn = function(scope, element, attr) { - // ensuring ngChecked doesn't interfere with ngModel when both are set on the same input - if (attr.ngModel !== attr[normalized]) { - defaultLinkFn(scope, element, attr); - } - }; - } - - ngAttributeAliasDirectives[normalized] = function() { - return { - restrict: 'A', - priority: 100, - link: linkFn - }; - }; -}); - -// aliased input attrs are evaluated -forEach(ALIASED_ATTR, function(htmlAttr, ngAttr) { - ngAttributeAliasDirectives[ngAttr] = function() { - return { - priority: 100, - link: function(scope, element, attr) { - //special case ngPattern when a literal regular expression value - //is used as the expression (this way we don't have to watch anything). - if (ngAttr === 'ngPattern' && attr.ngPattern.charAt(0) === '/') { - var match = attr.ngPattern.match(REGEX_STRING_REGEXP); - if (match) { - attr.$set('ngPattern', new RegExp(match[1], match[2])); - return; - } - } - - scope.$watch(attr[ngAttr], function ngAttrAliasWatchAction(value) { - attr.$set(ngAttr, value); - }); - } - }; - }; -}); - -// ng-src, ng-srcset, ng-href are interpolated -forEach(['src', 'srcset', 'href'], function(attrName) { - var normalized = directiveNormalize('ng-' + attrName); - ngAttributeAliasDirectives[normalized] = function() { - return { - priority: 99, // it needs to run after the attributes are interpolated - link: function(scope, element, attr) { - var propName = attrName, - name = attrName; - - if (attrName === 'href' && - toString.call(element.prop('href')) === '[object SVGAnimatedString]') { - name = 'xlinkHref'; - attr.$attr[name] = 'xlink:href'; - propName = null; - } - - attr.$observe(normalized, function(value) { - if (!value) { - if (attrName === 'href') { - attr.$set(name, null); - } - return; - } - - attr.$set(name, value); - - // Support: IE 9-11 only - // On IE, if "ng:src" directive declaration is used and "src" attribute doesn't exist - // then calling element.setAttribute('src', 'foo') doesn't do anything, so we need - // to set the property as well to achieve the desired effect. - // We use attr[attrName] value since $set can sanitize the url. - if (msie && propName) element.prop(propName, attr[name]); - }); - } - }; - }; -}); - -/* global -nullFormCtrl, -PENDING_CLASS, -SUBMITTED_CLASS - */ -var nullFormCtrl = { - $addControl: noop, - $$renameControl: nullFormRenameControl, - $removeControl: noop, - $setValidity: noop, - $setDirty: noop, - $setPristine: noop, - $setSubmitted: noop -}, -PENDING_CLASS = 'ng-pending', -SUBMITTED_CLASS = 'ng-submitted'; - -function nullFormRenameControl(control, name) { - control.$name = name; -} - -/** - * @ngdoc type - * @name form.FormController - * - * @property {boolean} $pristine True if user has not interacted with the form yet. - * @property {boolean} $dirty True if user has already interacted with the form. - * @property {boolean} $valid True if all of the containing forms and controls are valid. - * @property {boolean} $invalid True if at least one containing control or form is invalid. - * @property {boolean} $pending True if at least one containing control or form is pending. - * @property {boolean} $submitted True if user has submitted the form even if its invalid. - * - * @property {Object} $error Is an object hash, containing references to controls or - * forms with failing validators, where: - * - * - keys are validation tokens (error names), - * - values are arrays of controls or forms that have a failing validator for given error name. - * - * Built-in validation tokens: - * - * - `email` - * - `max` - * - `maxlength` - * - `min` - * - `minlength` - * - `number` - * - `pattern` - * - `required` - * - `url` - * - `date` - * - `datetimelocal` - * - `time` - * - `week` - * - `month` - * - * @description - * `FormController` keeps track of all its controls and nested forms as well as the state of them, - * such as being valid/invalid or dirty/pristine. - * - * Each {@link ng.directive:form form} directive creates an instance - * of `FormController`. - * - */ -//asks for $scope to fool the BC controller module -FormController.$inject = ['$element', '$attrs', '$scope', '$animate', '$interpolate']; -function FormController($element, $attrs, $scope, $animate, $interpolate) { - this.$$controls = []; - - // init state - this.$error = {}; - this.$$success = {}; - this.$pending = undefined; - this.$name = $interpolate($attrs.name || $attrs.ngForm || '')($scope); - this.$dirty = false; - this.$pristine = true; - this.$valid = true; - this.$invalid = false; - this.$submitted = false; - this.$$parentForm = nullFormCtrl; - - this.$$element = $element; - this.$$animate = $animate; - - setupValidity(this); -} - -FormController.prototype = { - /** - * @ngdoc method - * @name form.FormController#$rollbackViewValue - * - * @description - * Rollback all form controls pending updates to the `$modelValue`. - * - * Updates may be pending by a debounced event or because the input is waiting for a some future - * event defined in `ng-model-options`. This method is typically needed by the reset button of - * a form that uses `ng-model-options` to pend updates. - */ - $rollbackViewValue: function() { - forEach(this.$$controls, function(control) { - control.$rollbackViewValue(); - }); - }, - - /** - * @ngdoc method - * @name form.FormController#$commitViewValue - * - * @description - * Commit all form controls pending updates to the `$modelValue`. - * - * Updates may be pending by a debounced event or because the input is waiting for a some future - * event defined in `ng-model-options`. This method is rarely needed as `NgModelController` - * usually handles calling this in response to input events. - */ - $commitViewValue: function() { - forEach(this.$$controls, function(control) { - control.$commitViewValue(); - }); - }, - - /** - * @ngdoc method - * @name form.FormController#$addControl - * @param {object} control control object, either a {@link form.FormController} or an - * {@link ngModel.NgModelController} - * - * @description - * Register a control with the form. Input elements using ngModelController do this automatically - * when they are linked. - * - * Note that the current state of the control will not be reflected on the new parent form. This - * is not an issue with normal use, as freshly compiled and linked controls are in a `$pristine` - * state. - * - * However, if the method is used programmatically, for example by adding dynamically created controls, - * or controls that have been previously removed without destroying their corresponding DOM element, - * it's the developers responsibility to make sure the current state propagates to the parent form. - * - * For example, if an input control is added that is already `$dirty` and has `$error` properties, - * calling `$setDirty()` and `$validate()` afterwards will propagate the state to the parent form. - */ - $addControl: function(control) { - // Breaking change - before, inputs whose name was "hasOwnProperty" were quietly ignored - // and not added to the scope. Now we throw an error. - assertNotHasOwnProperty(control.$name, 'input'); - this.$$controls.push(control); - - if (control.$name) { - this[control.$name] = control; - } - - control.$$parentForm = this; - }, - - // Private API: rename a form control - $$renameControl: function(control, newName) { - var oldName = control.$name; - - if (this[oldName] === control) { - delete this[oldName]; - } - this[newName] = control; - control.$name = newName; - }, - - /** - * @ngdoc method - * @name form.FormController#$removeControl - * @param {object} control control object, either a {@link form.FormController} or an - * {@link ngModel.NgModelController} - * - * @description - * Deregister a control from the form. - * - * Input elements using ngModelController do this automatically when they are destroyed. - * - * Note that only the removed control's validation state (`$errors`etc.) will be removed from the - * form. `$dirty`, `$submitted` states will not be changed, because the expected behavior can be - * different from case to case. For example, removing the only `$dirty` control from a form may or - * may not mean that the form is still `$dirty`. - */ - $removeControl: function(control) { - if (control.$name && this[control.$name] === control) { - delete this[control.$name]; - } - forEach(this.$pending, function(value, name) { - // eslint-disable-next-line no-invalid-this - this.$setValidity(name, null, control); - }, this); - forEach(this.$error, function(value, name) { - // eslint-disable-next-line no-invalid-this - this.$setValidity(name, null, control); - }, this); - forEach(this.$$success, function(value, name) { - // eslint-disable-next-line no-invalid-this - this.$setValidity(name, null, control); - }, this); - - arrayRemove(this.$$controls, control); - control.$$parentForm = nullFormCtrl; - }, - - /** - * @ngdoc method - * @name form.FormController#$setDirty - * - * @description - * Sets the form to a dirty state. - * - * This method can be called to add the 'ng-dirty' class and set the form to a dirty - * state (ng-dirty class). This method will also propagate to parent forms. - */ - $setDirty: function() { - this.$$animate.removeClass(this.$$element, PRISTINE_CLASS); - this.$$animate.addClass(this.$$element, DIRTY_CLASS); - this.$dirty = true; - this.$pristine = false; - this.$$parentForm.$setDirty(); - }, - - /** - * @ngdoc method - * @name form.FormController#$setPristine - * - * @description - * Sets the form to its pristine state. - * - * This method sets the form's `$pristine` state to true, the `$dirty` state to false, removes - * the `ng-dirty` class and adds the `ng-pristine` class. Additionally, it sets the `$submitted` - * state to false. - * - * This method will also propagate to all the controls contained in this form. - * - * Setting a form back to a pristine state is often useful when we want to 'reuse' a form after - * saving or resetting it. - */ - $setPristine: function() { - this.$$animate.setClass(this.$$element, PRISTINE_CLASS, DIRTY_CLASS + ' ' + SUBMITTED_CLASS); - this.$dirty = false; - this.$pristine = true; - this.$submitted = false; - forEach(this.$$controls, function(control) { - control.$setPristine(); - }); - }, - - /** - * @ngdoc method - * @name form.FormController#$setUntouched - * - * @description - * Sets the form to its untouched state. - * - * This method can be called to remove the 'ng-touched' class and set the form controls to their - * untouched state (ng-untouched class). - * - * Setting a form controls back to their untouched state is often useful when setting the form - * back to its pristine state. - */ - $setUntouched: function() { - forEach(this.$$controls, function(control) { - control.$setUntouched(); - }); - }, - - /** - * @ngdoc method - * @name form.FormController#$setSubmitted - * - * @description - * Sets the form to its submitted state. - */ - $setSubmitted: function() { - this.$$animate.addClass(this.$$element, SUBMITTED_CLASS); - this.$submitted = true; - this.$$parentForm.$setSubmitted(); - } -}; - -/** - * @ngdoc method - * @name form.FormController#$setValidity - * - * @description - * Sets the validity of a form control. - * - * This method will also propagate to parent forms. - */ -addSetValidityMethod({ - clazz: FormController, - set: function(object, property, controller) { - var list = object[property]; - if (!list) { - object[property] = [controller]; - } else { - var index = list.indexOf(controller); - if (index === -1) { - list.push(controller); - } - } - }, - unset: function(object, property, controller) { - var list = object[property]; - if (!list) { - return; - } - arrayRemove(list, controller); - if (list.length === 0) { - delete object[property]; - } - } -}); - -/** - * @ngdoc directive - * @name ngForm - * @restrict EAC - * - * @description - * Nestable alias of {@link ng.directive:form `form`} directive. HTML - * does not allow nesting of form elements. It is useful to nest forms, for example if the validity of a - * sub-group of controls needs to be determined. - * - * Note: the purpose of `ngForm` is to group controls, - * but not to be a replacement for the `
` tag with all of its capabilities - * (e.g. posting to the server, ...). - * - * @param {string=} ngForm|name Name of the form. If specified, the form controller will be published into - * related scope, under this name. - * - */ - - /** - * @ngdoc directive - * @name form - * @restrict E - * - * @description - * Directive that instantiates - * {@link form.FormController FormController}. - * - * If the `name` attribute is specified, the form controller is published onto the current scope under - * this name. - * - * # Alias: {@link ng.directive:ngForm `ngForm`} - * - * In Angular, forms can be nested. This means that the outer form is valid when all of the child - * forms are valid as well. However, browsers do not allow nesting of `` elements, so - * Angular provides the {@link ng.directive:ngForm `ngForm`} directive, which behaves identically to - * `form` but can be nested. Nested forms can be useful, for example, if the validity of a sub-group - * of controls needs to be determined. - * - * # CSS classes - * - `ng-valid` is set if the form is valid. - * - `ng-invalid` is set if the form is invalid. - * - `ng-pending` is set if the form is pending. - * - `ng-pristine` is set if the form is pristine. - * - `ng-dirty` is set if the form is dirty. - * - `ng-submitted` is set if the form was submitted. - * - * Keep in mind that ngAnimate can detect each of these classes when added and removed. - * - * - * # Submitting a form and preventing the default action - * - * Since the role of forms in client-side Angular applications is different than in classical - * roundtrip apps, it is desirable for the browser not to translate the form submission into a full - * page reload that sends the data to the server. Instead some javascript logic should be triggered - * to handle the form submission in an application-specific way. - * - * For this reason, Angular prevents the default action (form submission to the server) unless the - * `` element has an `action` attribute specified. - * - * You can use one of the following two ways to specify what javascript method should be called when - * a form is submitted: - * - * - {@link ng.directive:ngSubmit ngSubmit} directive on the form element - * - {@link ng.directive:ngClick ngClick} directive on the first - * button or input field of type submit (input[type=submit]) - * - * To prevent double execution of the handler, use only one of the {@link ng.directive:ngSubmit ngSubmit} - * or {@link ng.directive:ngClick ngClick} directives. - * This is because of the following form submission rules in the HTML specification: - * - * - If a form has only one input field then hitting enter in this field triggers form submit - * (`ngSubmit`) - * - if a form has 2+ input fields and no buttons or input[type=submit] then hitting enter - * doesn't trigger submit - * - if a form has one or more input fields and one or more buttons or input[type=submit] then - * hitting enter in any of the input fields will trigger the click handler on the *first* button or - * input[type=submit] (`ngClick`) *and* a submit handler on the enclosing form (`ngSubmit`) - * - * Any pending `ngModelOptions` changes will take place immediately when an enclosing form is - * submitted. Note that `ngClick` events will occur before the model is updated. Use `ngSubmit` - * to have access to the updated model. - * - * ## Animation Hooks - * - * Animations in ngForm are triggered when any of the associated CSS classes are added and removed. - * These classes are: `.ng-pristine`, `.ng-dirty`, `.ng-invalid` and `.ng-valid` as well as any - * other validations that are performed within the form. Animations in ngForm are similar to how - * they work in ngClass and animations can be hooked into using CSS transitions, keyframes as well - * as JS animations. - * - * The following example shows a simple way to utilize CSS transitions to style a form element - * that has been rendered as invalid after it has been validated: - * - * 
- * //be sure to include ngAnimate as a module to hook into more
- * //advanced animations
- * .my-form {
- *   transition:0.5s linear all;
- *   background: white;
- * }
- * .my-form.ng-invalid {
- *   background: red;
- *   color:white;
- * }
- *
- * - * @example - - - - - - userType: - Required!
- userType = {{userType}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
- - - - it('should initialize to model', function() { - var userType = element(by.binding('userType')); - var valid = element(by.binding('myForm.input.$valid')); - - expect(userType.getText()).toContain('guest'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - var userType = element(by.binding('userType')); - var valid = element(by.binding('myForm.input.$valid')); - var userInput = element(by.model('userType')); - - userInput.clear(); - userInput.sendKeys(''); - - expect(userType.getText()).toEqual('userType ='); - expect(valid.getText()).toContain('false'); - }); - -
- * - * @param {string=} name Name of the form. If specified, the form controller will be published into - * related scope, under this name. - */ -var formDirectiveFactory = function(isNgForm) { - return ['$timeout', '$parse', function($timeout, $parse) { - var formDirective = { - name: 'form', - restrict: isNgForm ? 'EAC' : 'E', - require: ['form', '^^?form'], //first is the form's own ctrl, second is an optional parent form - controller: FormController, - compile: function ngFormCompile(formElement, attr) { - // Setup initial state of the control - formElement.addClass(PRISTINE_CLASS).addClass(VALID_CLASS); - - var nameAttr = attr.name ? 'name' : (isNgForm && attr.ngForm ? 'ngForm' : false); - - return { - pre: function ngFormPreLink(scope, formElement, attr, ctrls) { - var controller = ctrls[0]; - - // if `action` attr is not present on the form, prevent the default action (submission) - if (!('action' in attr)) { - // we can't use jq events because if a form is destroyed during submission the default - // action is not prevented. see #1238 - // - // IE 9 is not affected because it doesn't fire a submit event and try to do a full - // page reload if the form was destroyed by submission of the form via a click handler - // on a button in the form. Looks like an IE9 specific bug. - var handleFormSubmission = function(event) { - scope.$apply(function() { - controller.$commitViewValue(); - controller.$setSubmitted(); - }); - - event.preventDefault(); - }; - - formElement[0].addEventListener('submit', handleFormSubmission); - - // unregister the preventDefault listener so that we don't not leak memory but in a - // way that will achieve the prevention of the default action. - formElement.on('$destroy', function() { - $timeout(function() { - formElement[0].removeEventListener('submit', handleFormSubmission); - }, 0, false); - }); - } - - var parentFormCtrl = ctrls[1] || controller.$$parentForm; - parentFormCtrl.$addControl(controller); - - var setter = nameAttr ? getSetter(controller.$name) : noop; - - if (nameAttr) { - setter(scope, controller); - attr.$observe(nameAttr, function(newValue) { - if (controller.$name === newValue) return; - setter(scope, undefined); - controller.$$parentForm.$$renameControl(controller, newValue); - setter = getSetter(controller.$name); - setter(scope, controller); - }); - } - formElement.on('$destroy', function() { - controller.$$parentForm.$removeControl(controller); - setter(scope, undefined); - extend(controller, nullFormCtrl); //stop propagating child destruction handlers upwards - }); - } - }; - } - }; - - return formDirective; - - function getSetter(expression) { - if (expression === '') { - //create an assignable expression, so forms with an empty name can be renamed later - return $parse('this[""]').assign; - } - return $parse(expression).assign || noop; - } - }]; -}; - -var formDirective = formDirectiveFactory(); -var ngFormDirective = formDirectiveFactory(true); - - - -// helper methods -function setupValidity(instance) { - instance.$$classCache = {}; - instance.$$classCache[INVALID_CLASS] = !(instance.$$classCache[VALID_CLASS] = instance.$$element.hasClass(VALID_CLASS)); -} -function addSetValidityMethod(context) { - var clazz = context.clazz, - set = context.set, - unset = context.unset; - - clazz.prototype.$setValidity = function(validationErrorKey, state, controller) { - if (isUndefined(state)) { - createAndSet(this, '$pending', validationErrorKey, controller); - } else { - unsetAndCleanup(this, '$pending', validationErrorKey, controller); - } - if (!isBoolean(state)) { - unset(this.$error, validationErrorKey, controller); - unset(this.$$success, validationErrorKey, controller); - } else { - if (state) { - unset(this.$error, validationErrorKey, controller); - set(this.$$success, validationErrorKey, controller); - } else { - set(this.$error, validationErrorKey, controller); - unset(this.$$success, validationErrorKey, controller); - } - } - if (this.$pending) { - cachedToggleClass(this, PENDING_CLASS, true); - this.$valid = this.$invalid = undefined; - toggleValidationCss(this, '', null); - } else { - cachedToggleClass(this, PENDING_CLASS, false); - this.$valid = isObjectEmpty(this.$error); - this.$invalid = !this.$valid; - toggleValidationCss(this, '', this.$valid); - } - - // re-read the state as the set/unset methods could have - // combined state in this.$error[validationError] (used for forms), - // where setting/unsetting only increments/decrements the value, - // and does not replace it. - var combinedState; - if (this.$pending && this.$pending[validationErrorKey]) { - combinedState = undefined; - } else if (this.$error[validationErrorKey]) { - combinedState = false; - } else if (this.$$success[validationErrorKey]) { - combinedState = true; - } else { - combinedState = null; - } - - toggleValidationCss(this, validationErrorKey, combinedState); - this.$$parentForm.$setValidity(validationErrorKey, combinedState, this); - }; - - function createAndSet(ctrl, name, value, controller) { - if (!ctrl[name]) { - ctrl[name] = {}; - } - set(ctrl[name], value, controller); - } - - function unsetAndCleanup(ctrl, name, value, controller) { - if (ctrl[name]) { - unset(ctrl[name], value, controller); - } - if (isObjectEmpty(ctrl[name])) { - ctrl[name] = undefined; - } - } - - function cachedToggleClass(ctrl, className, switchValue) { - if (switchValue && !ctrl.$$classCache[className]) { - ctrl.$$animate.addClass(ctrl.$$element, className); - ctrl.$$classCache[className] = true; - } else if (!switchValue && ctrl.$$classCache[className]) { - ctrl.$$animate.removeClass(ctrl.$$element, className); - ctrl.$$classCache[className] = false; - } - } - - function toggleValidationCss(ctrl, validationErrorKey, isValid) { - validationErrorKey = validationErrorKey ? '-' + snake_case(validationErrorKey, '-') : ''; - - cachedToggleClass(ctrl, VALID_CLASS + validationErrorKey, isValid === true); - cachedToggleClass(ctrl, INVALID_CLASS + validationErrorKey, isValid === false); - } -} - -function isObjectEmpty(obj) { - if (obj) { - for (var prop in obj) { - if (obj.hasOwnProperty(prop)) { - return false; - } - } - } - return true; -} - -/* global - VALID_CLASS: false, - INVALID_CLASS: false, - PRISTINE_CLASS: false, - DIRTY_CLASS: false, - ngModelMinErr: false -*/ - -// Regex code was initially obtained from SO prior to modification: https://stackoverflow.com/questions/3143070/javascript-regex-iso-datetime#answer-3143231 -var ISO_DATE_REGEXP = /^\d{4,}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+(?:[+-][0-2]\d:[0-5]\d|Z)$/; -// See valid URLs in RFC3987 (http://tools.ietf.org/html/rfc3987) -// Note: We are being more lenient, because browsers are too. -// 1. Scheme -// 2. Slashes -// 3. Username -// 4. Password -// 5. Hostname -// 6. Port -// 7. Path -// 8. Query -// 9. Fragment -// 1111111111111111 222 333333 44444 55555555555555555555555 666 77777777 8888888 999 -var URL_REGEXP = /^[a-z][a-z\d.+-]*:\/*(?:[^:@]+(?::[^@]+)?@)?(?:[^\s:/?#]+|\[[a-f\d:]+])(?::\d+)?(?:\/[^?#]*)?(?:\?[^#]*)?(?:#.*)?$/i; -// eslint-disable-next-line max-len -var EMAIL_REGEXP = /^(?=.{1,254}$)(?=.{1,64}@)[-!#$%&'*+/0-9=?A-Z^_`a-z{|}~]+(\.[-!#$%&'*+/0-9=?A-Z^_`a-z{|}~]+)*@[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?(\.[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*$/; -var NUMBER_REGEXP = /^\s*(-|\+)?(\d+|(\d*(\.\d*)))([eE][+-]?\d+)?\s*$/; -var DATE_REGEXP = /^(\d{4,})-(\d{2})-(\d{2})$/; -var DATETIMELOCAL_REGEXP = /^(\d{4,})-(\d\d)-(\d\d)T(\d\d):(\d\d)(?::(\d\d)(\.\d{1,3})?)?$/; -var WEEK_REGEXP = /^(\d{4,})-W(\d\d)$/; -var MONTH_REGEXP = /^(\d{4,})-(\d\d)$/; -var TIME_REGEXP = /^(\d\d):(\d\d)(?::(\d\d)(\.\d{1,3})?)?$/; - -var PARTIAL_VALIDATION_EVENTS = 'keydown wheel mousedown'; -var PARTIAL_VALIDATION_TYPES = createMap(); -forEach('date,datetime-local,month,time,week'.split(','), function(type) { - PARTIAL_VALIDATION_TYPES[type] = true; -}); - -var inputType = { - - /** - * @ngdoc input - * @name input[text] - * - * @description - * Standard HTML text input with angular data binding, inherited by most of the `input` elements. - * - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Adds `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. Setting the attribute to a negative or non-numeric value, allows view values of - * any length. - * @param {string=} pattern Similar to `ngPattern` except that the attribute value is the actual string - * that contains the regular expression body that will be converted to a regular expression - * as in the ngPattern directive. - * @param {string=} ngPattern Sets `pattern` validation error key if the ngModel {@link ngModel.NgModelController#$viewValue $viewValue} - * does not match a RegExp found by evaluating the Angular expression given in the attribute value. - * If the expression evaluates to a RegExp object, then this is used directly. - * If the expression evaluates to a string, then it will be converted to a RegExp - * after wrapping it in `^` and `$` characters. For instance, `"abc"` will be converted to - * `new RegExp('^abc$')`.
- * **Note:** Avoid using the `g` flag on the RegExp, as it will cause each successive search to - * start at the index of the last search's match, thus not taking the whole input value into - * account. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * @param {boolean=} [ngTrim=true] If set to false Angular will not automatically trim the input. - * This parameter is ignored for input[type=password] controls, which will never trim the - * input. - * - * @example - - - -
- -
- - Required! - - Single word only! -
- text = {{example.text}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var text = element(by.binding('example.text')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('example.text')); - - it('should initialize to model', function() { - expect(text.getText()).toContain('guest'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - - expect(text.getText()).toEqual('text ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if multi word', function() { - input.clear(); - input.sendKeys('hello world'); - - expect(valid.getText()).toContain('false'); - }); - - - */ - 'text': textInputType, - - /** - * @ngdoc input - * @name input[date] - * - * @description - * Input with date validation and transformation. In browsers that do not yet support - * the HTML5 date input, a text element will be used. In that case, text must be entered in a valid ISO-8601 - * date format (yyyy-MM-dd), for example: `2009-01-06`. Since many - * modern browsers do not yet support this input type, it is important to provide cues to users on the - * expected input format via a placeholder or label. - * - * The model must always be a Date object, otherwise Angular will throw an error. - * Invalid `Date` objects (dates whose `getTime()` is `NaN`) will be rendered as an empty string. - * - * The timezone to be used to read/write the `Date` instance in the model can be defined using - * {@link ng.directive:ngModelOptions ngModelOptions}. By default, this is the timezone of the browser. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. This must be a - * valid ISO date string (yyyy-MM-dd). You can also use interpolation inside this attribute - * (e.g. `min="{{minDate | date:'yyyy-MM-dd'}}"`). Note that `min` will also add native HTML5 - * constraint validation. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. This must be - * a valid ISO date string (yyyy-MM-dd). You can also use interpolation inside this attribute - * (e.g. `max="{{maxDate | date:'yyyy-MM-dd'}}"`). Note that `max` will also add native HTML5 - * constraint validation. - * @param {(date|string)=} ngMin Sets the `min` validation constraint to the Date / ISO date string - * the `ngMin` expression evaluates to. Note that it does not set the `min` attribute. - * @param {(date|string)=} ngMax Sets the `max` validation constraint to the Date / ISO date string - * the `ngMax` expression evaluates to. Note that it does not set the `max` attribute. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- - -
- - Required! - - Not a valid date! -
- value = {{example.value | date: "yyyy-MM-dd"}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('example.value | date: "yyyy-MM-dd"')); - var valid = element(by.binding('myForm.input.$valid')); - - // currently protractor/webdriver does not support - // sending keys to all known HTML5 input controls - // for various browsers (see https://github.com/angular/protractor/issues/562). - function setInput(val) { - // set the value of the element and force validation. - var scr = "var ipt = document.getElementById('exampleInput'); " + - "ipt.value = '" + val + "';" + - "angular.element(ipt).scope().$apply(function(s) { s.myForm[ipt.name].$setViewValue('" + val + "'); });"; - browser.executeScript(scr); - } - - it('should initialize to model', function() { - expect(value.getText()).toContain('2013-10-22'); - expect(valid.getText()).toContain('myForm.input.$valid = true'); - }); - - it('should be invalid if empty', function() { - setInput(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - it('should be invalid if over max', function() { - setInput('2015-01-01'); - expect(value.getText()).toContain(''); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - - */ - 'date': createDateInputType('date', DATE_REGEXP, - createDateParser(DATE_REGEXP, ['yyyy', 'MM', 'dd']), - 'yyyy-MM-dd'), - - /** - * @ngdoc input - * @name input[datetime-local] - * - * @description - * Input with datetime validation and transformation. In browsers that do not yet support - * the HTML5 date input, a text element will be used. In that case, the text must be entered in a valid ISO-8601 - * local datetime format (yyyy-MM-ddTHH:mm:ss), for example: `2010-12-28T14:57:00`. - * - * The model must always be a Date object, otherwise Angular will throw an error. - * Invalid `Date` objects (dates whose `getTime()` is `NaN`) will be rendered as an empty string. - * - * The timezone to be used to read/write the `Date` instance in the model can be defined using - * {@link ng.directive:ngModelOptions ngModelOptions}. By default, this is the timezone of the browser. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. - * This must be a valid ISO datetime format (yyyy-MM-ddTHH:mm:ss). You can also use interpolation - * inside this attribute (e.g. `min="{{minDatetimeLocal | date:'yyyy-MM-ddTHH:mm:ss'}}"`). - * Note that `min` will also add native HTML5 constraint validation. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. - * This must be a valid ISO datetime format (yyyy-MM-ddTHH:mm:ss). You can also use interpolation - * inside this attribute (e.g. `max="{{maxDatetimeLocal | date:'yyyy-MM-ddTHH:mm:ss'}}"`). - * Note that `max` will also add native HTML5 constraint validation. - * @param {(date|string)=} ngMin Sets the `min` validation error key to the Date / ISO datetime string - * the `ngMin` expression evaluates to. Note that it does not set the `min` attribute. - * @param {(date|string)=} ngMax Sets the `max` validation error key to the Date / ISO datetime string - * the `ngMax` expression evaluates to. Note that it does not set the `max` attribute. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- - -
- - Required! - - Not a valid date! -
- value = {{example.value | date: "yyyy-MM-ddTHH:mm:ss"}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('example.value | date: "yyyy-MM-ddTHH:mm:ss"')); - var valid = element(by.binding('myForm.input.$valid')); - - // currently protractor/webdriver does not support - // sending keys to all known HTML5 input controls - // for various browsers (https://github.com/angular/protractor/issues/562). - function setInput(val) { - // set the value of the element and force validation. - var scr = "var ipt = document.getElementById('exampleInput'); " + - "ipt.value = '" + val + "';" + - "angular.element(ipt).scope().$apply(function(s) { s.myForm[ipt.name].$setViewValue('" + val + "'); });"; - browser.executeScript(scr); - } - - it('should initialize to model', function() { - expect(value.getText()).toContain('2010-12-28T14:57:00'); - expect(valid.getText()).toContain('myForm.input.$valid = true'); - }); - - it('should be invalid if empty', function() { - setInput(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - it('should be invalid if over max', function() { - setInput('2015-01-01T23:59:00'); - expect(value.getText()).toContain(''); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - - */ - 'datetime-local': createDateInputType('datetimelocal', DATETIMELOCAL_REGEXP, - createDateParser(DATETIMELOCAL_REGEXP, ['yyyy', 'MM', 'dd', 'HH', 'mm', 'ss', 'sss']), - 'yyyy-MM-ddTHH:mm:ss.sss'), - - /** - * @ngdoc input - * @name input[time] - * - * @description - * Input with time validation and transformation. In browsers that do not yet support - * the HTML5 time input, a text element will be used. In that case, the text must be entered in a valid ISO-8601 - * local time format (HH:mm:ss), for example: `14:57:00`. Model must be a Date object. This binding will always output a - * Date object to the model of January 1, 1970, or local date `new Date(1970, 0, 1, HH, mm, ss)`. - * - * The model must always be a Date object, otherwise Angular will throw an error. - * Invalid `Date` objects (dates whose `getTime()` is `NaN`) will be rendered as an empty string. - * - * The timezone to be used to read/write the `Date` instance in the model can be defined using - * {@link ng.directive:ngModelOptions ngModelOptions}. By default, this is the timezone of the browser. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. - * This must be a valid ISO time format (HH:mm:ss). You can also use interpolation inside this - * attribute (e.g. `min="{{minTime | date:'HH:mm:ss'}}"`). Note that `min` will also add - * native HTML5 constraint validation. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. - * This must be a valid ISO time format (HH:mm:ss). You can also use interpolation inside this - * attribute (e.g. `max="{{maxTime | date:'HH:mm:ss'}}"`). Note that `max` will also add - * native HTML5 constraint validation. - * @param {(date|string)=} ngMin Sets the `min` validation constraint to the Date / ISO time string the - * `ngMin` expression evaluates to. Note that it does not set the `min` attribute. - * @param {(date|string)=} ngMax Sets the `max` validation constraint to the Date / ISO time string the - * `ngMax` expression evaluates to. Note that it does not set the `max` attribute. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- - -
- - Required! - - Not a valid date! -
- value = {{example.value | date: "HH:mm:ss"}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('example.value | date: "HH:mm:ss"')); - var valid = element(by.binding('myForm.input.$valid')); - - // currently protractor/webdriver does not support - // sending keys to all known HTML5 input controls - // for various browsers (https://github.com/angular/protractor/issues/562). - function setInput(val) { - // set the value of the element and force validation. - var scr = "var ipt = document.getElementById('exampleInput'); " + - "ipt.value = '" + val + "';" + - "angular.element(ipt).scope().$apply(function(s) { s.myForm[ipt.name].$setViewValue('" + val + "'); });"; - browser.executeScript(scr); - } - - it('should initialize to model', function() { - expect(value.getText()).toContain('14:57:00'); - expect(valid.getText()).toContain('myForm.input.$valid = true'); - }); - - it('should be invalid if empty', function() { - setInput(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - it('should be invalid if over max', function() { - setInput('23:59:00'); - expect(value.getText()).toContain(''); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - - */ - 'time': createDateInputType('time', TIME_REGEXP, - createDateParser(TIME_REGEXP, ['HH', 'mm', 'ss', 'sss']), - 'HH:mm:ss.sss'), - - /** - * @ngdoc input - * @name input[week] - * - * @description - * Input with week-of-the-year validation and transformation to Date. In browsers that do not yet support - * the HTML5 week input, a text element will be used. In that case, the text must be entered in a valid ISO-8601 - * week format (yyyy-W##), for example: `2013-W02`. - * - * The model must always be a Date object, otherwise Angular will throw an error. - * Invalid `Date` objects (dates whose `getTime()` is `NaN`) will be rendered as an empty string. - * - * The timezone to be used to read/write the `Date` instance in the model can be defined using - * {@link ng.directive:ngModelOptions ngModelOptions}. By default, this is the timezone of the browser. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. - * This must be a valid ISO week format (yyyy-W##). You can also use interpolation inside this - * attribute (e.g. `min="{{minWeek | date:'yyyy-Www'}}"`). Note that `min` will also add - * native HTML5 constraint validation. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. - * This must be a valid ISO week format (yyyy-W##). You can also use interpolation inside this - * attribute (e.g. `max="{{maxWeek | date:'yyyy-Www'}}"`). Note that `max` will also add - * native HTML5 constraint validation. - * @param {(date|string)=} ngMin Sets the `min` validation constraint to the Date / ISO week string - * the `ngMin` expression evaluates to. Note that it does not set the `min` attribute. - * @param {(date|string)=} ngMax Sets the `max` validation constraint to the Date / ISO week string - * the `ngMax` expression evaluates to. Note that it does not set the `max` attribute. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- -
- - Required! - - Not a valid date! -
- value = {{example.value | date: "yyyy-Www"}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('example.value | date: "yyyy-Www"')); - var valid = element(by.binding('myForm.input.$valid')); - - // currently protractor/webdriver does not support - // sending keys to all known HTML5 input controls - // for various browsers (https://github.com/angular/protractor/issues/562). - function setInput(val) { - // set the value of the element and force validation. - var scr = "var ipt = document.getElementById('exampleInput'); " + - "ipt.value = '" + val + "';" + - "angular.element(ipt).scope().$apply(function(s) { s.myForm[ipt.name].$setViewValue('" + val + "'); });"; - browser.executeScript(scr); - } - - it('should initialize to model', function() { - expect(value.getText()).toContain('2013-W01'); - expect(valid.getText()).toContain('myForm.input.$valid = true'); - }); - - it('should be invalid if empty', function() { - setInput(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - it('should be invalid if over max', function() { - setInput('2015-W01'); - expect(value.getText()).toContain(''); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - - */ - 'week': createDateInputType('week', WEEK_REGEXP, weekParser, 'yyyy-Www'), - - /** - * @ngdoc input - * @name input[month] - * - * @description - * Input with month validation and transformation. In browsers that do not yet support - * the HTML5 month input, a text element will be used. In that case, the text must be entered in a valid ISO-8601 - * month format (yyyy-MM), for example: `2009-01`. - * - * The model must always be a Date object, otherwise Angular will throw an error. - * Invalid `Date` objects (dates whose `getTime()` is `NaN`) will be rendered as an empty string. - * If the model is not set to the first of the month, the next view to model update will set it - * to the first of the month. - * - * The timezone to be used to read/write the `Date` instance in the model can be defined using - * {@link ng.directive:ngModelOptions ngModelOptions}. By default, this is the timezone of the browser. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. - * This must be a valid ISO month format (yyyy-MM). You can also use interpolation inside this - * attribute (e.g. `min="{{minMonth | date:'yyyy-MM'}}"`). Note that `min` will also add - * native HTML5 constraint validation. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. - * This must be a valid ISO month format (yyyy-MM). You can also use interpolation inside this - * attribute (e.g. `max="{{maxMonth | date:'yyyy-MM'}}"`). Note that `max` will also add - * native HTML5 constraint validation. - * @param {(date|string)=} ngMin Sets the `min` validation constraint to the Date / ISO week string - * the `ngMin` expression evaluates to. Note that it does not set the `min` attribute. - * @param {(date|string)=} ngMax Sets the `max` validation constraint to the Date / ISO week string - * the `ngMax` expression evaluates to. Note that it does not set the `max` attribute. - - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- - -
- - Required! - - Not a valid month! -
- value = {{example.value | date: "yyyy-MM"}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('example.value | date: "yyyy-MM"')); - var valid = element(by.binding('myForm.input.$valid')); - - // currently protractor/webdriver does not support - // sending keys to all known HTML5 input controls - // for various browsers (https://github.com/angular/protractor/issues/562). - function setInput(val) { - // set the value of the element and force validation. - var scr = "var ipt = document.getElementById('exampleInput'); " + - "ipt.value = '" + val + "';" + - "angular.element(ipt).scope().$apply(function(s) { s.myForm[ipt.name].$setViewValue('" + val + "'); });"; - browser.executeScript(scr); - } - - it('should initialize to model', function() { - expect(value.getText()).toContain('2013-10'); - expect(valid.getText()).toContain('myForm.input.$valid = true'); - }); - - it('should be invalid if empty', function() { - setInput(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - it('should be invalid if over max', function() { - setInput('2015-01'); - expect(value.getText()).toContain(''); - expect(valid.getText()).toContain('myForm.input.$valid = false'); - }); - - - */ - 'month': createDateInputType('month', MONTH_REGEXP, - createDateParser(MONTH_REGEXP, ['yyyy', 'MM']), - 'yyyy-MM'), - - /** - * @ngdoc input - * @name input[number] - * - * @description - * Text input with number validation and transformation. Sets the `number` validation - * error if not a valid number. - * - *
- * The model must always be of type `number` otherwise Angular will throw an error. - * Be aware that a string containing a number is not enough. See the {@link ngModel:numfmt} - * error docs for more information and an example of how to convert your model if necessary. - *
- * - * ## Issues with HTML5 constraint validation - * - * In browsers that follow the - * [HTML5 specification](https://html.spec.whatwg.org/multipage/forms.html#number-state-%28type=number%29), - * `input[number]` does not work as expected with {@link ngModelOptions `ngModelOptions.allowInvalid`}. - * If a non-number is entered in the input, the browser will report the value as an empty string, - * which means the view / model values in `ngModel` and subsequently the scope value - * will also be an empty string. - * - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. - * Can be interpolated. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. - * Can be interpolated. - * @param {string=} ngMin Like `min`, sets the `min` validation error key if the value entered is less than `ngMin`, - * but does not trigger HTML5 native validation. Takes an expression. - * @param {string=} ngMax Like `max`, sets the `max` validation error key if the value entered is greater than `ngMax`, - * but does not trigger HTML5 native validation. Takes an expression. - * @param {string=} step Sets the `step` validation error key if the value entered does not fit the `step` constraint. - * Can be interpolated. - * @param {string=} ngStep Like `step`, sets the `step` validation error key if the value entered does not fit the `ngStep` constraint, - * but does not trigger HTML5 native validation. Takes an expression. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. Setting the attribute to a negative or non-numeric value, allows view values of - * any length. - * @param {string=} pattern Similar to `ngPattern` except that the attribute value is the actual string - * that contains the regular expression body that will be converted to a regular expression - * as in the ngPattern directive. - * @param {string=} ngPattern Sets `pattern` validation error key if the ngModel {@link ngModel.NgModelController#$viewValue $viewValue} - * does not match a RegExp found by evaluating the Angular expression given in the attribute value. - * If the expression evaluates to a RegExp object, then this is used directly. - * If the expression evaluates to a string, then it will be converted to a RegExp - * after wrapping it in `^` and `$` characters. For instance, `"abc"` will be converted to - * `new RegExp('^abc$')`.
- * **Note:** Avoid using the `g` flag on the RegExp, as it will cause each successive search to - * start at the index of the last search's match, thus not taking the whole input value into - * account. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- -
- - Required! - - Not valid number! -
- value = {{example.value}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('example.value')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('example.value')); - - it('should initialize to model', function() { - expect(value.getText()).toContain('12'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if over max', function() { - input.clear(); - input.sendKeys('123'); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('false'); - }); - - - */ - 'number': numberInputType, - - - /** - * @ngdoc input - * @name input[url] - * - * @description - * Text input with URL validation. Sets the `url` validation error key if the content is not a - * valid URL. - * - *
- * **Note:** `input[url]` uses a regex to validate urls that is derived from the regex - * used in Chromium. If you need stricter validation, you can use `ng-pattern` or modify - * the built-in validators (see the {@link guide/forms Forms guide}) - *
- * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. Setting the attribute to a negative or non-numeric value, allows view values of - * any length. - * @param {string=} pattern Similar to `ngPattern` except that the attribute value is the actual string - * that contains the regular expression body that will be converted to a regular expression - * as in the ngPattern directive. - * @param {string=} ngPattern Sets `pattern` validation error key if the ngModel {@link ngModel.NgModelController#$viewValue $viewValue} - * does not match a RegExp found by evaluating the Angular expression given in the attribute value. - * If the expression evaluates to a RegExp object, then this is used directly. - * If the expression evaluates to a string, then it will be converted to a RegExp - * after wrapping it in `^` and `$` characters. For instance, `"abc"` will be converted to - * `new RegExp('^abc$')`.
- * **Note:** Avoid using the `g` flag on the RegExp, as it will cause each successive search to - * start at the index of the last search's match, thus not taking the whole input value into - * account. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
-
- - var text = element(by.binding('url.text')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('url.text')); - - it('should initialize to model', function() { - expect(text.getText()).toContain('http://google.com'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - - expect(text.getText()).toEqual('text ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if not url', function() { - input.clear(); - input.sendKeys('box'); - - expect(valid.getText()).toContain('false'); - }); - - - */ - 'url': urlInputType, - - - /** - * @ngdoc input - * @name input[email] - * - * @description - * Text input with email validation. Sets the `email` validation error key if not a valid email - * address. - * - *
- * **Note:** `input[email]` uses a regex to validate email addresses that is derived from the regex - * used in Chromium. If you need stricter validation (e.g. requiring a top-level domain), you can - * use `ng-pattern` or modify the built-in validators (see the {@link guide/forms Forms guide}) - *
- * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. Setting the attribute to a negative or non-numeric value, allows view values of - * any length. - * @param {string=} pattern Similar to `ngPattern` except that the attribute value is the actual string - * that contains the regular expression body that will be converted to a regular expression - * as in the ngPattern directive. - * @param {string=} ngPattern Sets `pattern` validation error key if the ngModel {@link ngModel.NgModelController#$viewValue $viewValue} - * does not match a RegExp found by evaluating the Angular expression given in the attribute value. - * If the expression evaluates to a RegExp object, then this is used directly. - * If the expression evaluates to a string, then it will be converted to a RegExp - * after wrapping it in `^` and `$` characters. For instance, `"abc"` will be converted to - * `new RegExp('^abc$')`.
- * **Note:** Avoid using the `g` flag on the RegExp, as it will cause each successive search to - * start at the index of the last search's match, thus not taking the whole input value into - * account. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- -
- - Required! - - Not valid email! -
- text = {{email.text}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
- myForm.$error.email = {{!!myForm.$error.email}}
-
- - - var text = element(by.binding('email.text')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('email.text')); - - it('should initialize to model', function() { - expect(text.getText()).toContain('me@example.com'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - expect(text.getText()).toEqual('text ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if not email', function() { - input.clear(); - input.sendKeys('xxx'); - - expect(valid.getText()).toContain('false'); - }); - - - */ - 'email': emailInputType, - - - /** - * @ngdoc input - * @name input[radio] - * - * @description - * HTML radio button. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string} value The value to which the `ngModel` expression should be set when selected. - * Note that `value` only supports `string` values, i.e. the scope model needs to be a string, - * too. Use `ngValue` if you need complex models (`number`, `object`, ...). - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * @param {string} ngValue Angular expression to which `ngModel` will be be set when the radio - * is selected. Should be used instead of the `value` attribute if you need - * a non-string `ngModel` (`boolean`, `array`, ...). - * - * @example - - - -
-
-
-
- color = {{color.name | json}}
-
- Note that `ng-value="specialValue"` sets radio item's value to be the value of `$scope.specialValue`. - - - it('should change state', function() { - var inputs = element.all(by.model('color.name')); - var color = element(by.binding('color.name')); - - expect(color.getText()).toContain('blue'); - - inputs.get(0).click(); - expect(color.getText()).toContain('red'); - - inputs.get(1).click(); - expect(color.getText()).toContain('green'); - }); - - - */ - 'radio': radioInputType, - - /** - * @ngdoc input - * @name input[range] - * - * @description - * Native range input with validation and transformation. - * - * The model for the range input must always be a `Number`. - * - * IE9 and other browsers that do not support the `range` type fall back - * to a text input without any default values for `min`, `max` and `step`. Model binding, - * validation and number parsing are nevertheless supported. - * - * Browsers that support range (latest Chrome, Safari, Firefox, Edge) treat `input[range]` - * in a way that never allows the input to hold an invalid value. That means: - * - any non-numerical value is set to `(max + min) / 2`. - * - any numerical value that is less than the current min val, or greater than the current max val - * is set to the min / max val respectively. - * - additionally, the current `step` is respected, so the nearest value that satisfies a step - * is used. - * - * See the [HTML Spec on input[type=range]](https://www.w3.org/TR/html5/forms.html#range-state-(type=range)) - * for more info. - * - * This has the following consequences for Angular: - * - * Since the element value should always reflect the current model value, a range input - * will set the bound ngModel expression to the value that the browser has set for the - * input element. For example, in the following input ``, - * if the application sets `model.value = null`, the browser will set the input to `'50'`. - * Angular will then set the model to `50`, to prevent input and model value being out of sync. - * - * That means the model for range will immediately be set to `50` after `ngModel` has been - * initialized. It also means a range input can never have the required error. - * - * This does not only affect changes to the model value, but also to the values of the `min`, - * `max`, and `step` attributes. When these change in a way that will cause the browser to modify - * the input value, Angular will also update the model value. - * - * Automatic value adjustment also means that a range input element can never have the `required`, - * `min`, or `max` errors. - * - * However, `step` is currently only fully implemented by Firefox. Other browsers have problems - * when the step value changes dynamically - they do not adjust the element value correctly, but - * instead may set the `stepMismatch` error. If that's the case, the Angular will set the `step` - * error on the input, and set the model to `undefined`. - * - * Note that `input[range]` is not compatible with`ngMax`, `ngMin`, and `ngStep`, because they do - * not set the `min` and `max` attributes, which means that the browser won't automatically adjust - * the input value based on their values, and will always assume min = 0, max = 100, and step = 1. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation to ensure that the value entered is greater - * than `min`. Can be interpolated. - * @param {string=} max Sets the `max` validation to ensure that the value entered is less than `max`. - * Can be interpolated. - * @param {string=} step Sets the `step` validation to ensure that the value entered matches the `step` - * Can be interpolated. - * @param {string=} ngChange Angular expression to be executed when the ngModel value changes due - * to user interaction with the input element. - * @param {expression=} ngChecked If the expression is truthy, then the `checked` attribute will be set on the - * element. **Note** : `ngChecked` should not be used alongside `ngModel`. - * Checkout {@link ng.directive:ngChecked ngChecked} for usage. - * - * @example - - - -
- - Model as range: -
- Model as number:
- Min:
- Max:
- value = {{value}}
- myForm.range.$valid = {{myForm.range.$valid}}
- myForm.range.$error = {{myForm.range.$error}} -
- - - - * ## Range Input with ngMin & ngMax attributes - - * @example - - - -
- Model as range: -
- Model as number:
- Min:
- Max:
- value = {{value}}
- myForm.range.$valid = {{myForm.range.$valid}}
- myForm.range.$error = {{myForm.range.$error}} -
- - - - */ - 'range': rangeInputType, - - /** - * @ngdoc input - * @name input[checkbox] - * - * @description - * HTML checkbox. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {expression=} ngTrueValue The value to which the expression should be set when selected. - * @param {expression=} ngFalseValue The value to which the expression should be set when not selected. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
-
-
- value1 = {{checkboxModel.value1}}
- value2 = {{checkboxModel.value2}}
-
- - - it('should change state', function() { - var value1 = element(by.binding('checkboxModel.value1')); - var value2 = element(by.binding('checkboxModel.value2')); - - expect(value1.getText()).toContain('true'); - expect(value2.getText()).toContain('YES'); - - element(by.model('checkboxModel.value1')).click(); - element(by.model('checkboxModel.value2')).click(); - - expect(value1.getText()).toContain('false'); - expect(value2.getText()).toContain('NO'); - }); - - - */ - 'checkbox': checkboxInputType, - - 'hidden': noop, - 'button': noop, - 'submit': noop, - 'reset': noop, - 'file': noop -}; - -function stringBasedInputType(ctrl) { - ctrl.$formatters.push(function(value) { - return ctrl.$isEmpty(value) ? value : value.toString(); - }); -} - -function textInputType(scope, element, attr, ctrl, $sniffer, $browser) { - baseInputType(scope, element, attr, ctrl, $sniffer, $browser); - stringBasedInputType(ctrl); -} - -function baseInputType(scope, element, attr, ctrl, $sniffer, $browser) { - var type = lowercase(element[0].type); - - // In composition mode, users are still inputting intermediate text buffer, - // hold the listener until composition is done. - // More about composition events: https://developer.mozilla.org/en-US/docs/Web/API/CompositionEvent - if (!$sniffer.android) { - var composing = false; - - element.on('compositionstart', function() { - composing = true; - }); - - element.on('compositionend', function() { - composing = false; - listener(); - }); - } - - var timeout; - - var listener = function(ev) { - if (timeout) { - $browser.defer.cancel(timeout); - timeout = null; - } - if (composing) return; - var value = element.val(), - event = ev && ev.type; - - // By default we will trim the value - // If the attribute ng-trim exists we will avoid trimming - // If input type is 'password', the value is never trimmed - if (type !== 'password' && (!attr.ngTrim || attr.ngTrim !== 'false')) { - value = trim(value); - } - - // If a control is suffering from bad input (due to native validators), browsers discard its - // value, so it may be necessary to revalidate (by calling $setViewValue again) even if the - // control's value is the same empty value twice in a row. - if (ctrl.$viewValue !== value || (value === '' && ctrl.$$hasNativeValidators)) { - ctrl.$setViewValue(value, event); - } - }; - - // if the browser does support "input" event, we are fine - except on IE9 which doesn't fire the - // input event on backspace, delete or cut - if ($sniffer.hasEvent('input')) { - element.on('input', listener); - } else { - var deferListener = function(ev, input, origValue) { - if (!timeout) { - timeout = $browser.defer(function() { - timeout = null; - if (!input || input.value !== origValue) { - listener(ev); - } - }); - } - }; - - element.on('keydown', /** @this */ function(event) { - var key = event.keyCode; - - // ignore - // command modifiers arrows - if (key === 91 || (15 < key && key < 19) || (37 <= key && key <= 40)) return; - - deferListener(event, this, this.value); - }); - - // if user modifies input value using context menu in IE, we need "paste" and "cut" events to catch it - if ($sniffer.hasEvent('paste')) { - element.on('paste cut', deferListener); - } - } - - // if user paste into input using mouse on older browser - // or form autocomplete on newer browser, we need "change" event to catch it - element.on('change', listener); - - // Some native input types (date-family) have the ability to change validity without - // firing any input/change events. - // For these event types, when native validators are present and the browser supports the type, - // check for validity changes on various DOM events. - if (PARTIAL_VALIDATION_TYPES[type] && ctrl.$$hasNativeValidators && type === attr.type) { - element.on(PARTIAL_VALIDATION_EVENTS, /** @this */ function(ev) { - if (!timeout) { - var validity = this[VALIDITY_STATE_PROPERTY]; - var origBadInput = validity.badInput; - var origTypeMismatch = validity.typeMismatch; - timeout = $browser.defer(function() { - timeout = null; - if (validity.badInput !== origBadInput || validity.typeMismatch !== origTypeMismatch) { - listener(ev); - } - }); - } - }); - } - - ctrl.$render = function() { - // Workaround for Firefox validation #12102. - var value = ctrl.$isEmpty(ctrl.$viewValue) ? '' : ctrl.$viewValue; - if (element.val() !== value) { - element.val(value); - } - }; -} - -function weekParser(isoWeek, existingDate) { - if (isDate(isoWeek)) { - return isoWeek; - } - - if (isString(isoWeek)) { - WEEK_REGEXP.lastIndex = 0; - var parts = WEEK_REGEXP.exec(isoWeek); - if (parts) { - var year = +parts[1], - week = +parts[2], - hours = 0, - minutes = 0, - seconds = 0, - milliseconds = 0, - firstThurs = getFirstThursdayOfYear(year), - addDays = (week - 1) * 7; - - if (existingDate) { - hours = existingDate.getHours(); - minutes = existingDate.getMinutes(); - seconds = existingDate.getSeconds(); - milliseconds = existingDate.getMilliseconds(); - } - - return new Date(year, 0, firstThurs.getDate() + addDays, hours, minutes, seconds, milliseconds); - } - } - - return NaN; -} - -function createDateParser(regexp, mapping) { - return function(iso, date) { - var parts, map; - - if (isDate(iso)) { - return iso; - } - - if (isString(iso)) { - // When a date is JSON'ified to wraps itself inside of an extra - // set of double quotes. This makes the date parsing code unable - // to match the date string and parse it as a date. - if (iso.charAt(0) === '"' && iso.charAt(iso.length - 1) === '"') { - iso = iso.substring(1, iso.length - 1); - } - if (ISO_DATE_REGEXP.test(iso)) { - return new Date(iso); - } - regexp.lastIndex = 0; - parts = regexp.exec(iso); - - if (parts) { - parts.shift(); - if (date) { - map = { - yyyy: date.getFullYear(), - MM: date.getMonth() + 1, - dd: date.getDate(), - HH: date.getHours(), - mm: date.getMinutes(), - ss: date.getSeconds(), - sss: date.getMilliseconds() / 1000 - }; - } else { - map = { yyyy: 1970, MM: 1, dd: 1, HH: 0, mm: 0, ss: 0, sss: 0 }; - } - - forEach(parts, function(part, index) { - if (index < mapping.length) { - map[mapping[index]] = +part; - } - }); - return new Date(map.yyyy, map.MM - 1, map.dd, map.HH, map.mm, map.ss || 0, map.sss * 1000 || 0); - } - } - - return NaN; - }; -} - -function createDateInputType(type, regexp, parseDate, format) { - return function dynamicDateInputType(scope, element, attr, ctrl, $sniffer, $browser, $filter) { - badInputChecker(scope, element, attr, ctrl); - baseInputType(scope, element, attr, ctrl, $sniffer, $browser); - var timezone = ctrl && ctrl.$options.getOption('timezone'); - var previousDate; - - ctrl.$$parserName = type; - ctrl.$parsers.push(function(value) { - if (ctrl.$isEmpty(value)) return null; - if (regexp.test(value)) { - // Note: We cannot read ctrl.$modelValue, as there might be a different - // parser/formatter in the processing chain so that the model - // contains some different data format! - var parsedDate = parseDate(value, previousDate); - if (timezone) { - parsedDate = convertTimezoneToLocal(parsedDate, timezone); - } - return parsedDate; - } - return undefined; - }); - - ctrl.$formatters.push(function(value) { - if (value && !isDate(value)) { - throw ngModelMinErr('datefmt', 'Expected `{0}` to be a date', value); - } - if (isValidDate(value)) { - previousDate = value; - if (previousDate && timezone) { - previousDate = convertTimezoneToLocal(previousDate, timezone, true); - } - return $filter('date')(value, format, timezone); - } else { - previousDate = null; - return ''; - } - }); - - if (isDefined(attr.min) || attr.ngMin) { - var minVal; - ctrl.$validators.min = function(value) { - return !isValidDate(value) || isUndefined(minVal) || parseDate(value) >= minVal; - }; - attr.$observe('min', function(val) { - minVal = parseObservedDateValue(val); - ctrl.$validate(); - }); - } - - if (isDefined(attr.max) || attr.ngMax) { - var maxVal; - ctrl.$validators.max = function(value) { - return !isValidDate(value) || isUndefined(maxVal) || parseDate(value) <= maxVal; - }; - attr.$observe('max', function(val) { - maxVal = parseObservedDateValue(val); - ctrl.$validate(); - }); - } - - function isValidDate(value) { - // Invalid Date: getTime() returns NaN - return value && !(value.getTime && value.getTime() !== value.getTime()); - } - - function parseObservedDateValue(val) { - return isDefined(val) && !isDate(val) ? parseDate(val) || undefined : val; - } - }; -} - -function badInputChecker(scope, element, attr, ctrl) { - var node = element[0]; - var nativeValidation = ctrl.$$hasNativeValidators = isObject(node.validity); - if (nativeValidation) { - ctrl.$parsers.push(function(value) { - var validity = element.prop(VALIDITY_STATE_PROPERTY) || {}; - return validity.badInput || validity.typeMismatch ? undefined : value; - }); - } -} - -function numberFormatterParser(ctrl) { - ctrl.$$parserName = 'number'; - ctrl.$parsers.push(function(value) { - if (ctrl.$isEmpty(value)) return null; - if (NUMBER_REGEXP.test(value)) return parseFloat(value); - return undefined; - }); - - ctrl.$formatters.push(function(value) { - if (!ctrl.$isEmpty(value)) { - if (!isNumber(value)) { - throw ngModelMinErr('numfmt', 'Expected `{0}` to be a number', value); - } - value = value.toString(); - } - return value; - }); -} - -function parseNumberAttrVal(val) { - if (isDefined(val) && !isNumber(val)) { - val = parseFloat(val); - } - return !isNumberNaN(val) ? val : undefined; -} - -function isNumberInteger(num) { - // See http://stackoverflow.com/questions/14636536/how-to-check-if-a-variable-is-an-integer-in-javascript#14794066 - // (minus the assumption that `num` is a number) - - // eslint-disable-next-line no-bitwise - return (num | 0) === num; -} - -function countDecimals(num) { - var numString = num.toString(); - var decimalSymbolIndex = numString.indexOf('.'); - - if (decimalSymbolIndex === -1) { - if (-1 < num && num < 1) { - // It may be in the exponential notation format (`1e-X`) - var match = /e-(\d+)$/.exec(numString); - - if (match) { - return Number(match[1]); - } - } - - return 0; - } - - return numString.length - decimalSymbolIndex - 1; -} - -function isValidForStep(viewValue, stepBase, step) { - // At this point `stepBase` and `step` are expected to be non-NaN values - // and `viewValue` is expected to be a valid stringified number. - var value = Number(viewValue); - - // Due to limitations in Floating Point Arithmetic (e.g. `0.3 - 0.2 !== 0.1` or - // `0.5 % 0.1 !== 0`), we need to convert all numbers to integers. - if (!isNumberInteger(value) || !isNumberInteger(stepBase) || !isNumberInteger(step)) { - var decimalCount = Math.max(countDecimals(value), countDecimals(stepBase), countDecimals(step)); - var multiplier = Math.pow(10, decimalCount); - - value = value * multiplier; - stepBase = stepBase * multiplier; - step = step * multiplier; - } - - return (value - stepBase) % step === 0; -} - -function numberInputType(scope, element, attr, ctrl, $sniffer, $browser) { - badInputChecker(scope, element, attr, ctrl); - numberFormatterParser(ctrl); - baseInputType(scope, element, attr, ctrl, $sniffer, $browser); - - var minVal; - var maxVal; - - if (isDefined(attr.min) || attr.ngMin) { - ctrl.$validators.min = function(value) { - return ctrl.$isEmpty(value) || isUndefined(minVal) || value >= minVal; - }; - - attr.$observe('min', function(val) { - minVal = parseNumberAttrVal(val); - // TODO(matsko): implement validateLater to reduce number of validations - ctrl.$validate(); - }); - } - - if (isDefined(attr.max) || attr.ngMax) { - ctrl.$validators.max = function(value) { - return ctrl.$isEmpty(value) || isUndefined(maxVal) || value <= maxVal; - }; - - attr.$observe('max', function(val) { - maxVal = parseNumberAttrVal(val); - // TODO(matsko): implement validateLater to reduce number of validations - ctrl.$validate(); - }); - } - - if (isDefined(attr.step) || attr.ngStep) { - var stepVal; - ctrl.$validators.step = function(modelValue, viewValue) { - return ctrl.$isEmpty(viewValue) || isUndefined(stepVal) || - isValidForStep(viewValue, minVal || 0, stepVal); - }; - - attr.$observe('step', function(val) { - stepVal = parseNumberAttrVal(val); - // TODO(matsko): implement validateLater to reduce number of validations - ctrl.$validate(); - }); - } -} - -function rangeInputType(scope, element, attr, ctrl, $sniffer, $browser) { - badInputChecker(scope, element, attr, ctrl); - numberFormatterParser(ctrl); - baseInputType(scope, element, attr, ctrl, $sniffer, $browser); - - var supportsRange = ctrl.$$hasNativeValidators && element[0].type === 'range', - minVal = supportsRange ? 0 : undefined, - maxVal = supportsRange ? 100 : undefined, - stepVal = supportsRange ? 1 : undefined, - validity = element[0].validity, - hasMinAttr = isDefined(attr.min), - hasMaxAttr = isDefined(attr.max), - hasStepAttr = isDefined(attr.step); - - var originalRender = ctrl.$render; - - ctrl.$render = supportsRange && isDefined(validity.rangeUnderflow) && isDefined(validity.rangeOverflow) ? - //Browsers that implement range will set these values automatically, but reading the adjusted values after - //$render would cause the min / max validators to be applied with the wrong value - function rangeRender() { - originalRender(); - ctrl.$setViewValue(element.val()); - } : - originalRender; - - if (hasMinAttr) { - ctrl.$validators.min = supportsRange ? - // Since all browsers set the input to a valid value, we don't need to check validity - function noopMinValidator() { return true; } : - // non-support browsers validate the min val - function minValidator(modelValue, viewValue) { - return ctrl.$isEmpty(viewValue) || isUndefined(minVal) || viewValue >= minVal; - }; - - setInitialValueAndObserver('min', minChange); - } - - if (hasMaxAttr) { - ctrl.$validators.max = supportsRange ? - // Since all browsers set the input to a valid value, we don't need to check validity - function noopMaxValidator() { return true; } : - // non-support browsers validate the max val - function maxValidator(modelValue, viewValue) { - return ctrl.$isEmpty(viewValue) || isUndefined(maxVal) || viewValue <= maxVal; - }; - - setInitialValueAndObserver('max', maxChange); - } - - if (hasStepAttr) { - ctrl.$validators.step = supportsRange ? - function nativeStepValidator() { - // Currently, only FF implements the spec on step change correctly (i.e. adjusting the - // input element value to a valid value). It's possible that other browsers set the stepMismatch - // validity error instead, so we can at least report an error in that case. - return !validity.stepMismatch; - } : - // ngStep doesn't set the setp attr, so the browser doesn't adjust the input value as setting step would - function stepValidator(modelValue, viewValue) { - return ctrl.$isEmpty(viewValue) || isUndefined(stepVal) || - isValidForStep(viewValue, minVal || 0, stepVal); - }; - - setInitialValueAndObserver('step', stepChange); - } - - function setInitialValueAndObserver(htmlAttrName, changeFn) { - // interpolated attributes set the attribute value only after a digest, but we need the - // attribute value when the input is first rendered, so that the browser can adjust the - // input value based on the min/max value - element.attr(htmlAttrName, attr[htmlAttrName]); - attr.$observe(htmlAttrName, changeFn); - } - - function minChange(val) { - minVal = parseNumberAttrVal(val); - // ignore changes before model is initialized - if (isNumberNaN(ctrl.$modelValue)) { - return; - } - - if (supportsRange) { - var elVal = element.val(); - // IE11 doesn't set the el val correctly if the minVal is greater than the element value - if (minVal > elVal) { - elVal = minVal; - element.val(elVal); - } - ctrl.$setViewValue(elVal); - } else { - // TODO(matsko): implement validateLater to reduce number of validations - ctrl.$validate(); - } - } - - function maxChange(val) { - maxVal = parseNumberAttrVal(val); - // ignore changes before model is initialized - if (isNumberNaN(ctrl.$modelValue)) { - return; - } - - if (supportsRange) { - var elVal = element.val(); - // IE11 doesn't set the el val correctly if the maxVal is less than the element value - if (maxVal < elVal) { - element.val(maxVal); - // IE11 and Chrome don't set the value to the minVal when max < min - elVal = maxVal < minVal ? minVal : maxVal; - } - ctrl.$setViewValue(elVal); - } else { - // TODO(matsko): implement validateLater to reduce number of validations - ctrl.$validate(); - } - } - - function stepChange(val) { - stepVal = parseNumberAttrVal(val); - // ignore changes before model is initialized - if (isNumberNaN(ctrl.$modelValue)) { - return; - } - - // Some browsers don't adjust the input value correctly, but set the stepMismatch error - if (supportsRange && ctrl.$viewValue !== element.val()) { - ctrl.$setViewValue(element.val()); - } else { - // TODO(matsko): implement validateLater to reduce number of validations - ctrl.$validate(); - } - } -} - -function urlInputType(scope, element, attr, ctrl, $sniffer, $browser) { - // Note: no badInputChecker here by purpose as `url` is only a validation - // in browsers, i.e. we can always read out input.value even if it is not valid! - baseInputType(scope, element, attr, ctrl, $sniffer, $browser); - stringBasedInputType(ctrl); - - ctrl.$$parserName = 'url'; - ctrl.$validators.url = function(modelValue, viewValue) { - var value = modelValue || viewValue; - return ctrl.$isEmpty(value) || URL_REGEXP.test(value); - }; -} - -function emailInputType(scope, element, attr, ctrl, $sniffer, $browser) { - // Note: no badInputChecker here by purpose as `url` is only a validation - // in browsers, i.e. we can always read out input.value even if it is not valid! - baseInputType(scope, element, attr, ctrl, $sniffer, $browser); - stringBasedInputType(ctrl); - - ctrl.$$parserName = 'email'; - ctrl.$validators.email = function(modelValue, viewValue) { - var value = modelValue || viewValue; - return ctrl.$isEmpty(value) || EMAIL_REGEXP.test(value); - }; -} - -function radioInputType(scope, element, attr, ctrl) { - var doTrim = !attr.ngTrim || trim(attr.ngTrim) !== 'false'; - // make the name unique, if not defined - if (isUndefined(attr.name)) { - element.attr('name', nextUid()); - } - - var listener = function(ev) { - var value; - if (element[0].checked) { - value = attr.value; - if (doTrim) { - value = trim(value); - } - ctrl.$setViewValue(value, ev && ev.type); - } - }; - - element.on('click', listener); - - ctrl.$render = function() { - var value = attr.value; - if (doTrim) { - value = trim(value); - } - element[0].checked = (value === ctrl.$viewValue); - }; - - attr.$observe('value', ctrl.$render); -} - -function parseConstantExpr($parse, context, name, expression, fallback) { - var parseFn; - if (isDefined(expression)) { - parseFn = $parse(expression); - if (!parseFn.constant) { - throw ngModelMinErr('constexpr', 'Expected constant expression for `{0}`, but saw ' + - '`{1}`.', name, expression); - } - return parseFn(context); - } - return fallback; -} - -function checkboxInputType(scope, element, attr, ctrl, $sniffer, $browser, $filter, $parse) { - var trueValue = parseConstantExpr($parse, scope, 'ngTrueValue', attr.ngTrueValue, true); - var falseValue = parseConstantExpr($parse, scope, 'ngFalseValue', attr.ngFalseValue, false); - - var listener = function(ev) { - ctrl.$setViewValue(element[0].checked, ev && ev.type); - }; - - element.on('click', listener); - - ctrl.$render = function() { - element[0].checked = ctrl.$viewValue; - }; - - // Override the standard `$isEmpty` because the $viewValue of an empty checkbox is always set to `false` - // This is because of the parser below, which compares the `$modelValue` with `trueValue` to convert - // it to a boolean. - ctrl.$isEmpty = function(value) { - return value === false; - }; - - ctrl.$formatters.push(function(value) { - return equals(value, trueValue); - }); - - ctrl.$parsers.push(function(value) { - return value ? trueValue : falseValue; - }); -} - - -/** - * @ngdoc directive - * @name textarea - * @restrict E - * - * @description - * HTML textarea element control with angular data-binding. The data-binding and validation - * properties of this element are exactly the same as those of the - * {@link ng.directive:input input element}. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. Setting the attribute to a negative or non-numeric value, allows view values of any - * length. - * @param {string=} ngPattern Sets `pattern` validation error key if the ngModel {@link ngModel.NgModelController#$viewValue $viewValue} - * does not match a RegExp found by evaluating the Angular expression given in the attribute value. - * If the expression evaluates to a RegExp object, then this is used directly. - * If the expression evaluates to a string, then it will be converted to a RegExp - * after wrapping it in `^` and `$` characters. For instance, `"abc"` will be converted to - * `new RegExp('^abc$')`.
- * **Note:** Avoid using the `g` flag on the RegExp, as it will cause each successive search to - * start at the index of the last search's match, thus not taking the whole input value into - * account. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * @param {boolean=} [ngTrim=true] If set to false Angular will not automatically trim the input. - * - * @knownIssue - * - * When specifying the `placeholder` attribute of ` - * 
{{ list | json }}
- * - * - * it("should split the text by newlines", function() { - * var listInput = element(by.model('list')); - * var output = element(by.binding('list | json')); - * listInput.sendKeys('abc\ndef\nghi'); - * expect(output.getText()).toContain('[\n "abc",\n "def",\n "ghi"\n]'); - * }); - * - * - * - * @element input - * @param {string=} ngList optional delimiter that should be used to split the value. - */ -var ngListDirective = function() { - return { - restrict: 'A', - priority: 100, - require: 'ngModel', - link: function(scope, element, attr, ctrl) { - var ngList = attr.ngList || ', '; - var trimValues = attr.ngTrim !== 'false'; - var separator = trimValues ? trim(ngList) : ngList; - - var parse = function(viewValue) { - // If the viewValue is invalid (say required but empty) it will be `undefined` - if (isUndefined(viewValue)) return; - - var list = []; - - if (viewValue) { - forEach(viewValue.split(separator), function(value) { - if (value) list.push(trimValues ? trim(value) : value); - }); - } - - return list; - }; - - ctrl.$parsers.push(parse); - ctrl.$formatters.push(function(value) { - if (isArray(value)) { - return value.join(ngList); - } - - return undefined; - }); - - // Override the standard $isEmpty because an empty array means the input is empty. - ctrl.$isEmpty = function(value) { - return !value || !value.length; - }; - } - }; -}; - -/* global VALID_CLASS: true, - INVALID_CLASS: true, - PRISTINE_CLASS: true, - DIRTY_CLASS: true, - UNTOUCHED_CLASS: true, - TOUCHED_CLASS: true, - PENDING_CLASS: true, - addSetValidityMethod: true, - setupValidity: true, - defaultModelOptions: false -*/ - - -var VALID_CLASS = 'ng-valid', - INVALID_CLASS = 'ng-invalid', - PRISTINE_CLASS = 'ng-pristine', - DIRTY_CLASS = 'ng-dirty', - UNTOUCHED_CLASS = 'ng-untouched', - TOUCHED_CLASS = 'ng-touched', - EMPTY_CLASS = 'ng-empty', - NOT_EMPTY_CLASS = 'ng-not-empty'; - -var ngModelMinErr = minErr('ngModel'); - -/** - * @ngdoc type - * @name ngModel.NgModelController - * - * @property {*} $viewValue The actual value from the control's view. For `input` elements, this is a - * String. See {@link ngModel.NgModelController#$setViewValue} for information about when the $viewValue - * is set. - * @property {*} $modelValue The value in the model that the control is bound to. - * @property {Array.} $parsers Array of functions to execute, as a pipeline, whenever - the control reads value from the DOM. The functions are called in array order, each passing - its return value through to the next. The last return value is forwarded to the - {@link ngModel.NgModelController#$validators `$validators`} collection. - -Parsers are used to sanitize / convert the {@link ngModel.NgModelController#$viewValue -`$viewValue`}. - -Returning `undefined` from a parser means a parse error occurred. In that case, -no {@link ngModel.NgModelController#$validators `$validators`} will run and the `ngModel` -will be set to `undefined` unless {@link ngModelOptions `ngModelOptions.allowInvalid`} -is set to `true`. The parse error is stored in `ngModel.$error.parse`. - - * - * @property {Array.} $formatters Array of functions to execute, as a pipeline, whenever - the model value changes. The functions are called in reverse array order, each passing the value through to the - next. The last return value is used as the actual DOM value. - Used to format / convert values for display in the control. - * ```js - * function formatter(value) { - * if (value) { - * return value.toUpperCase(); - * } - * } - * ngModel.$formatters.push(formatter); - * ``` - * - * @property {Object.} $validators A collection of validators that are applied - * whenever the model value changes. The key value within the object refers to the name of the - * validator while the function refers to the validation operation. The validation operation is - * provided with the model value as an argument and must return a true or false value depending - * on the response of that validation. - * - * ```js - * ngModel.$validators.validCharacters = function(modelValue, viewValue) { - * var value = modelValue || viewValue; - * return /[0-9]+/.test(value) && - * /[a-z]+/.test(value) && - * /[A-Z]+/.test(value) && - * /\W+/.test(value); - * }; - * ``` - * - * @property {Object.} $asyncValidators A collection of validations that are expected to - * perform an asynchronous validation (e.g. a HTTP request). The validation function that is provided - * is expected to return a promise when it is run during the model validation process. Once the promise - * is delivered then the validation status will be set to true when fulfilled and false when rejected. - * When the asynchronous validators are triggered, each of the validators will run in parallel and the model - * value will only be updated once all validators have been fulfilled. As long as an asynchronous validator - * is unfulfilled, its key will be added to the controllers `$pending` property. Also, all asynchronous validators - * will only run once all synchronous validators have passed. - * - * Please note that if $http is used then it is important that the server returns a success HTTP response code - * in order to fulfill the validation and a status level of `4xx` in order to reject the validation. - * - * ```js - * ngModel.$asyncValidators.uniqueUsername = function(modelValue, viewValue) { - * var value = modelValue || viewValue; - * - * // Lookup user by username - * return $http.get('/api/users/' + value). - * then(function resolved() { - * //username exists, this means validation fails - * return $q.reject('exists'); - * }, function rejected() { - * //username does not exist, therefore this validation passes - * return true; - * }); - * }; - * ``` - * - * @property {Array.} $viewChangeListeners Array of functions to execute whenever the - * view value has changed. It is called with no arguments, and its return value is ignored. - * This can be used in place of additional $watches against the model value. - * - * @property {Object} $error An object hash with all failing validator ids as keys. - * @property {Object} $pending An object hash with all pending validator ids as keys. - * - * @property {boolean} $untouched True if control has not lost focus yet. - * @property {boolean} $touched True if control has lost focus. - * @property {boolean} $pristine True if user has not interacted with the control yet. - * @property {boolean} $dirty True if user has already interacted with the control. - * @property {boolean} $valid True if there is no error. - * @property {boolean} $invalid True if at least one error on the control. - * @property {string} $name The name attribute of the control. - * - * @description - * - * `NgModelController` provides API for the {@link ngModel `ngModel`} directive. - * The controller contains services for data-binding, validation, CSS updates, and value formatting - * and parsing. It purposefully does not contain any logic which deals with DOM rendering or - * listening to DOM events. - * Such DOM related logic should be provided by other directives which make use of - * `NgModelController` for data-binding to control elements. - * Angular provides this DOM logic for most {@link input `input`} elements. - * At the end of this page you can find a {@link ngModel.NgModelController#custom-control-example - * custom control example} that uses `ngModelController` to bind to `contenteditable` elements. - * - * @example - * ### Custom Control Example - * This example shows how to use `NgModelController` with a custom control to achieve - * data-binding. Notice how different directives (`contenteditable`, `ng-model`, and `required`) - * collaborate together to achieve the desired result. - * - * `contenteditable` is an HTML5 attribute, which tells the browser to let the element - * contents be edited in place by the user. - * - * We are using the {@link ng.service:$sce $sce} service here and include the {@link ngSanitize $sanitize} - * module to automatically remove "bad" content like inline event listener (e.g. ``). - * However, as we are using `$sce` the model can still decide to provide unsafe content if it marks - * that content using the `$sce` service. - * - * - - [contenteditable] { - border: 1px solid black; - background-color: white; - min-height: 20px; - } - - .ng-invalid { - border: 1px solid red; - } - - - - angular.module('customControl', ['ngSanitize']). - directive('contenteditable', ['$sce', function($sce) { - return { - restrict: 'A', // only activate on element attribute - require: '?ngModel', // get a hold of NgModelController - link: function(scope, element, attrs, ngModel) { - if (!ngModel) return; // do nothing if no ng-model - - // Specify how UI should be updated - ngModel.$render = function() { - element.html($sce.getTrustedHtml(ngModel.$viewValue || '')); - }; - - // Listen for change events to enable binding - element.on('blur keyup change', function() { - scope.$evalAsync(read); - }); - read(); // initialize - - // Write data to the model - function read() { - var html = element.html(); - // When we clear the content editable the browser leaves a
behind - // If strip-br attribute is provided then we strip this out - if (attrs.stripBr && html === '
') { - html = ''; - } - ngModel.$setViewValue(html); - } - } - }; - }]); - - -
-
Change me!
- Required! -
- -
- - - it('should data-bind and become invalid', function() { - if (browser.params.browser === 'safari' || browser.params.browser === 'firefox') { - // SafariDriver can't handle contenteditable - // and Firefox driver can't clear contenteditables very well - return; - } - var contentEditable = element(by.css('[contenteditable]')); - var content = 'Change me!'; - - expect(contentEditable.getText()).toEqual(content); - - contentEditable.clear(); - contentEditable.sendKeys(protractor.Key.BACK_SPACE); - expect(contentEditable.getText()).toEqual(''); - expect(contentEditable.getAttribute('class')).toMatch(/ng-invalid-required/); - }); - - * - * - * - */ -NgModelController.$inject = ['$scope', '$exceptionHandler', '$attrs', '$element', '$parse', '$animate', '$timeout', '$q', '$interpolate']; -function NgModelController($scope, $exceptionHandler, $attr, $element, $parse, $animate, $timeout, $q, $interpolate) { - this.$viewValue = Number.NaN; - this.$modelValue = Number.NaN; - this.$$rawModelValue = undefined; // stores the parsed modelValue / model set from scope regardless of validity. - this.$validators = {}; - this.$asyncValidators = {}; - this.$parsers = []; - this.$formatters = []; - this.$viewChangeListeners = []; - this.$untouched = true; - this.$touched = false; - this.$pristine = true; - this.$dirty = false; - this.$valid = true; - this.$invalid = false; - this.$error = {}; // keep invalid keys here - this.$$success = {}; // keep valid keys here - this.$pending = undefined; // keep pending keys here - this.$name = $interpolate($attr.name || '', false)($scope); - this.$$parentForm = nullFormCtrl; - this.$options = defaultModelOptions; - - this.$$parsedNgModel = $parse($attr.ngModel); - this.$$parsedNgModelAssign = this.$$parsedNgModel.assign; - this.$$ngModelGet = this.$$parsedNgModel; - this.$$ngModelSet = this.$$parsedNgModelAssign; - this.$$pendingDebounce = null; - this.$$parserValid = undefined; - - this.$$currentValidationRunId = 0; - - this.$$scope = $scope; - this.$$attr = $attr; - this.$$element = $element; - this.$$animate = $animate; - this.$$timeout = $timeout; - this.$$parse = $parse; - this.$$q = $q; - this.$$exceptionHandler = $exceptionHandler; - - setupValidity(this); - setupModelWatcher(this); -} - -NgModelController.prototype = { - $$initGetterSetters: function() { - if (this.$options.getOption('getterSetter')) { - var invokeModelGetter = this.$$parse(this.$$attr.ngModel + '()'), - invokeModelSetter = this.$$parse(this.$$attr.ngModel + '($$$p)'); - - this.$$ngModelGet = function($scope) { - var modelValue = this.$$parsedNgModel($scope); - if (isFunction(modelValue)) { - modelValue = invokeModelGetter($scope); - } - return modelValue; - }; - this.$$ngModelSet = function($scope, newValue) { - if (isFunction(this.$$parsedNgModel($scope))) { - invokeModelSetter($scope, {$$$p: newValue}); - } else { - this.$$parsedNgModelAssign($scope, newValue); - } - }; - } else if (!this.$$parsedNgModel.assign) { - throw ngModelMinErr('nonassign', 'Expression \'{0}\' is non-assignable. Element: {1}', - this.$$attr.ngModel, startingTag(this.$$element)); - } - }, - - - /** - * @ngdoc method - * @name ngModel.NgModelController#$render - * - * @description - * Called when the view needs to be updated. It is expected that the user of the ng-model - * directive will implement this method. - * - * The `$render()` method is invoked in the following situations: - * - * * `$rollbackViewValue()` is called. If we are rolling back the view value to the last - * committed value then `$render()` is called to update the input control. - * * The value referenced by `ng-model` is changed programmatically and both the `$modelValue` and - * the `$viewValue` are different from last time. - * - * Since `ng-model` does not do a deep watch, `$render()` is only invoked if the values of - * `$modelValue` and `$viewValue` are actually different from their previous values. If `$modelValue` - * or `$viewValue` are objects (rather than a string or number) then `$render()` will not be - * invoked if you only change a property on the objects. - */ - $render: noop, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$isEmpty - * - * @description - * This is called when we need to determine if the value of an input is empty. - * - * For instance, the required directive does this to work out if the input has data or not. - * - * The default `$isEmpty` function checks whether the value is `undefined`, `''`, `null` or `NaN`. - * - * You can override this for input directives whose concept of being empty is different from the - * default. The `checkboxInputType` directive does this because in its case a value of `false` - * implies empty. - * - * @param {*} value The value of the input to check for emptiness. - * @returns {boolean} True if `value` is "empty". - */ - $isEmpty: function(value) { - // eslint-disable-next-line no-self-compare - return isUndefined(value) || value === '' || value === null || value !== value; - }, - - $$updateEmptyClasses: function(value) { - if (this.$isEmpty(value)) { - this.$$animate.removeClass(this.$$element, NOT_EMPTY_CLASS); - this.$$animate.addClass(this.$$element, EMPTY_CLASS); - } else { - this.$$animate.removeClass(this.$$element, EMPTY_CLASS); - this.$$animate.addClass(this.$$element, NOT_EMPTY_CLASS); - } - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setPristine - * - * @description - * Sets the control to its pristine state. - * - * This method can be called to remove the `ng-dirty` class and set the control to its pristine - * state (`ng-pristine` class). A model is considered to be pristine when the control - * has not been changed from when first compiled. - */ - $setPristine: function() { - this.$dirty = false; - this.$pristine = true; - this.$$animate.removeClass(this.$$element, DIRTY_CLASS); - this.$$animate.addClass(this.$$element, PRISTINE_CLASS); - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setDirty - * - * @description - * Sets the control to its dirty state. - * - * This method can be called to remove the `ng-pristine` class and set the control to its dirty - * state (`ng-dirty` class). A model is considered to be dirty when the control has been changed - * from when first compiled. - */ - $setDirty: function() { - this.$dirty = true; - this.$pristine = false; - this.$$animate.removeClass(this.$$element, PRISTINE_CLASS); - this.$$animate.addClass(this.$$element, DIRTY_CLASS); - this.$$parentForm.$setDirty(); - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setUntouched - * - * @description - * Sets the control to its untouched state. - * - * This method can be called to remove the `ng-touched` class and set the control to its - * untouched state (`ng-untouched` class). Upon compilation, a model is set as untouched - * by default, however this function can be used to restore that state if the model has - * already been touched by the user. - */ - $setUntouched: function() { - this.$touched = false; - this.$untouched = true; - this.$$animate.setClass(this.$$element, UNTOUCHED_CLASS, TOUCHED_CLASS); - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setTouched - * - * @description - * Sets the control to its touched state. - * - * This method can be called to remove the `ng-untouched` class and set the control to its - * touched state (`ng-touched` class). A model is considered to be touched when the user has - * first focused the control element and then shifted focus away from the control (blur event). - */ - $setTouched: function() { - this.$touched = true; - this.$untouched = false; - this.$$animate.setClass(this.$$element, TOUCHED_CLASS, UNTOUCHED_CLASS); - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$rollbackViewValue - * - * @description - * Cancel an update and reset the input element's value to prevent an update to the `$modelValue`, - * which may be caused by a pending debounced event or because the input is waiting for some - * future event. - * - * If you have an input that uses `ng-model-options` to set up debounced updates or updates that - * depend on special events such as `blur`, there can be a period when the `$viewValue` is out of - * sync with the ngModel's `$modelValue`. - * - * In this case, you can use `$rollbackViewValue()` to manually cancel the debounced / future update - * and reset the input to the last committed view value. - * - * It is also possible that you run into difficulties if you try to update the ngModel's `$modelValue` - * programmatically before these debounced/future events have resolved/occurred, because Angular's - * dirty checking mechanism is not able to tell whether the model has actually changed or not. - * - * The `$rollbackViewValue()` method should be called before programmatically changing the model of an - * input which may have such events pending. This is important in order to make sure that the - * input field will be updated with the new model value and any pending operations are cancelled. - * - * - * - * angular.module('cancel-update-example', []) - * - * .controller('CancelUpdateController', ['$scope', function($scope) { - * $scope.model = {value1: '', value2: ''}; - * - * $scope.setEmpty = function(e, value, rollback) { - * if (e.keyCode === 27) { - * e.preventDefault(); - * if (rollback) { - * $scope.myForm[value].$rollbackViewValue(); - * } - * $scope.model[value] = ''; - * } - * }; - * }]); - * - * - *
- *

Both of these inputs are only updated if they are blurred. Hitting escape should - * empty them. Follow these steps and observe the difference:

- *
    - *
  1. Type something in the input. You will see that the model is not yet updated
    2. - *
  2. Press the Escape key. - *
      - *
    1. In the first example, nothing happens, because the model is already '', and no - * update is detected. If you blur the input, the model will be set to the current view. - *
      2. - *
    2. In the second example, the pending update is cancelled, and the input is set back - * to the last committed view value (''). Blurring the input does nothing. - *
      3. - *
    - *
    3. - *
- * - *
- *
- *

Without $rollbackViewValue():

- * - * value1: "{{ model.value1 }}" - *
- * - *
- *

With $rollbackViewValue():

- * - * value2: "{{ model.value2 }}" - *
- *
- *
- * - - div { - display: table-cell; - } - div:nth-child(1) { - padding-right: 30px; - } - - - * - */ - $rollbackViewValue: function() { - this.$$timeout.cancel(this.$$pendingDebounce); - this.$viewValue = this.$$lastCommittedViewValue; - this.$render(); - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$validate - * - * @description - * Runs each of the registered validators (first synchronous validators and then - * asynchronous validators). - * If the validity changes to invalid, the model will be set to `undefined`, - * unless {@link ngModelOptions `ngModelOptions.allowInvalid`} is `true`. - * If the validity changes to valid, it will set the model to the last available valid - * `$modelValue`, i.e. either the last parsed value or the last value set from the scope. - */ - $validate: function() { - // ignore $validate before model is initialized - if (isNumberNaN(this.$modelValue)) { - return; - } - - var viewValue = this.$$lastCommittedViewValue; - // Note: we use the $$rawModelValue as $modelValue might have been - // set to undefined during a view -> model update that found validation - // errors. We can't parse the view here, since that could change - // the model although neither viewValue nor the model on the scope changed - var modelValue = this.$$rawModelValue; - - var prevValid = this.$valid; - var prevModelValue = this.$modelValue; - - var allowInvalid = this.$options.getOption('allowInvalid'); - - var that = this; - this.$$runValidators(modelValue, viewValue, function(allValid) { - // If there was no change in validity, don't update the model - // This prevents changing an invalid modelValue to undefined - if (!allowInvalid && prevValid !== allValid) { - // Note: Don't check this.$valid here, as we could have - // external validators (e.g. calculated on the server), - // that just call $setValidity and need the model value - // to calculate their validity. - that.$modelValue = allValid ? modelValue : undefined; - - if (that.$modelValue !== prevModelValue) { - that.$$writeModelToScope(); - } - } - }); - }, - - $$runValidators: function(modelValue, viewValue, doneCallback) { - this.$$currentValidationRunId++; - var localValidationRunId = this.$$currentValidationRunId; - var that = this; - - // check parser error - if (!processParseErrors()) { - validationDone(false); - return; - } - if (!processSyncValidators()) { - validationDone(false); - return; - } - processAsyncValidators(); - - function processParseErrors() { - var errorKey = that.$$parserName || 'parse'; - if (isUndefined(that.$$parserValid)) { - setValidity(errorKey, null); - } else { - if (!that.$$parserValid) { - forEach(that.$validators, function(v, name) { - setValidity(name, null); - }); - forEach(that.$asyncValidators, function(v, name) { - setValidity(name, null); - }); - } - // Set the parse error last, to prevent unsetting it, should a $validators key == parserName - setValidity(errorKey, that.$$parserValid); - return that.$$parserValid; - } - return true; - } - - function processSyncValidators() { - var syncValidatorsValid = true; - forEach(that.$validators, function(validator, name) { - var result = Boolean(validator(modelValue, viewValue)); - syncValidatorsValid = syncValidatorsValid && result; - setValidity(name, result); - }); - if (!syncValidatorsValid) { - forEach(that.$asyncValidators, function(v, name) { - setValidity(name, null); - }); - return false; - } - return true; - } - - function processAsyncValidators() { - var validatorPromises = []; - var allValid = true; - forEach(that.$asyncValidators, function(validator, name) { - var promise = validator(modelValue, viewValue); - if (!isPromiseLike(promise)) { - throw ngModelMinErr('nopromise', - 'Expected asynchronous validator to return a promise but got \'{0}\' instead.', promise); - } - setValidity(name, undefined); - validatorPromises.push(promise.then(function() { - setValidity(name, true); - }, function() { - allValid = false; - setValidity(name, false); - })); - }); - if (!validatorPromises.length) { - validationDone(true); - } else { - that.$$q.all(validatorPromises).then(function() { - validationDone(allValid); - }, noop); - } - } - - function setValidity(name, isValid) { - if (localValidationRunId === that.$$currentValidationRunId) { - that.$setValidity(name, isValid); - } - } - - function validationDone(allValid) { - if (localValidationRunId === that.$$currentValidationRunId) { - - doneCallback(allValid); - } - } - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$commitViewValue - * - * @description - * Commit a pending update to the `$modelValue`. - * - * Updates may be pending by a debounced event or because the input is waiting for a some future - * event defined in `ng-model-options`. this method is rarely needed as `NgModelController` - * usually handles calling this in response to input events. - */ - $commitViewValue: function() { - var viewValue = this.$viewValue; - - this.$$timeout.cancel(this.$$pendingDebounce); - - // If the view value has not changed then we should just exit, except in the case where there is - // a native validator on the element. In this case the validation state may have changed even though - // the viewValue has stayed empty. - if (this.$$lastCommittedViewValue === viewValue && (viewValue !== '' || !this.$$hasNativeValidators)) { - return; - } - this.$$updateEmptyClasses(viewValue); - this.$$lastCommittedViewValue = viewValue; - - // change to dirty - if (this.$pristine) { - this.$setDirty(); - } - this.$$parseAndValidate(); - }, - - $$parseAndValidate: function() { - var viewValue = this.$$lastCommittedViewValue; - var modelValue = viewValue; - var that = this; - - this.$$parserValid = isUndefined(modelValue) ? undefined : true; - - if (this.$$parserValid) { - for (var i = 0; i < this.$parsers.length; i++) { - modelValue = this.$parsers[i](modelValue); - if (isUndefined(modelValue)) { - this.$$parserValid = false; - break; - } - } - } - if (isNumberNaN(this.$modelValue)) { - // this.$modelValue has not been touched yet... - this.$modelValue = this.$$ngModelGet(this.$$scope); - } - var prevModelValue = this.$modelValue; - var allowInvalid = this.$options.getOption('allowInvalid'); - this.$$rawModelValue = modelValue; - - if (allowInvalid) { - this.$modelValue = modelValue; - writeToModelIfNeeded(); - } - - // Pass the $$lastCommittedViewValue here, because the cached viewValue might be out of date. - // This can happen if e.g. $setViewValue is called from inside a parser - this.$$runValidators(modelValue, this.$$lastCommittedViewValue, function(allValid) { - if (!allowInvalid) { - // Note: Don't check this.$valid here, as we could have - // external validators (e.g. calculated on the server), - // that just call $setValidity and need the model value - // to calculate their validity. - that.$modelValue = allValid ? modelValue : undefined; - writeToModelIfNeeded(); - } - }); - - function writeToModelIfNeeded() { - if (that.$modelValue !== prevModelValue) { - that.$$writeModelToScope(); - } - } - }, - - $$writeModelToScope: function() { - this.$$ngModelSet(this.$$scope, this.$modelValue); - forEach(this.$viewChangeListeners, function(listener) { - try { - listener(); - } catch (e) { - // eslint-disable-next-line no-invalid-this - this.$$exceptionHandler(e); - } - }, this); - }, - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setViewValue - * - * @description - * Update the view value. - * - * This method should be called when a control wants to change the view value; typically, - * this is done from within a DOM event handler. For example, the {@link ng.directive:input input} - * directive calls it when the value of the input changes and {@link ng.directive:select select} - * calls it when an option is selected. - * - * When `$setViewValue` is called, the new `value` will be staged for committing through the `$parsers` - * and `$validators` pipelines. If there are no special {@link ngModelOptions} specified then the staged - * value sent directly for processing, finally to be applied to `$modelValue` and then the - * **expression** specified in the `ng-model` attribute. Lastly, all the registered change listeners, - * in the `$viewChangeListeners` list, are called. - * - * In case the {@link ng.directive:ngModelOptions ngModelOptions} directive is used with `updateOn` - * and the `default` trigger is not listed, all those actions will remain pending until one of the - * `updateOn` events is triggered on the DOM element. - * All these actions will be debounced if the {@link ng.directive:ngModelOptions ngModelOptions} - * directive is used with a custom debounce for this particular event. - * Note that a `$digest` is only triggered once the `updateOn` events are fired, or if `debounce` - * is specified, once the timer runs out. - * - * When used with standard inputs, the view value will always be a string (which is in some cases - * parsed into another type, such as a `Date` object for `input[date]`.) - * However, custom controls might also pass objects to this method. In this case, we should make - * a copy of the object before passing it to `$setViewValue`. This is because `ngModel` does not - * perform a deep watch of objects, it only looks for a change of identity. If you only change - * the property of the object then ngModel will not realize that the object has changed and - * will not invoke the `$parsers` and `$validators` pipelines. For this reason, you should - * not change properties of the copy once it has been passed to `$setViewValue`. - * Otherwise you may cause the model value on the scope to change incorrectly. - * - *
- * In any case, the value passed to the method should always reflect the current value - * of the control. For example, if you are calling `$setViewValue` for an input element, - * you should pass the input DOM value. Otherwise, the control and the scope model become - * out of sync. It's also important to note that `$setViewValue` does not call `$render` or change - * the control's DOM value in any way. If we want to change the control's DOM value - * programmatically, we should update the `ngModel` scope expression. Its new value will be - * picked up by the model controller, which will run it through the `$formatters`, `$render` it - * to update the DOM, and finally call `$validate` on it. - *
- * - * @param {*} value value from the view. - * @param {string} trigger Event that triggered the update. - */ - $setViewValue: function(value, trigger) { - this.$viewValue = value; - if (this.$options.getOption('updateOnDefault')) { - this.$$debounceViewValueCommit(trigger); - } - }, - - $$debounceViewValueCommit: function(trigger) { - var debounceDelay = this.$options.getOption('debounce'); - - if (isNumber(debounceDelay[trigger])) { - debounceDelay = debounceDelay[trigger]; - } else if (isNumber(debounceDelay['default'])) { - debounceDelay = debounceDelay['default']; - } - - this.$$timeout.cancel(this.$$pendingDebounce); - var that = this; - if (debounceDelay > 0) { // this fails if debounceDelay is an object - this.$$pendingDebounce = this.$$timeout(function() { - that.$commitViewValue(); - }, debounceDelay); - } else if (this.$$scope.$root.$$phase) { - this.$commitViewValue(); - } else { - this.$$scope.$apply(function() { - that.$commitViewValue(); - }); - } - } -}; - -function setupModelWatcher(ctrl) { - // model -> value - // Note: we cannot use a normal scope.$watch as we want to detect the following: - // 1. scope value is 'a' - // 2. user enters 'b' - // 3. ng-change kicks in and reverts scope value to 'a' - // -> scope value did not change since the last digest as - // ng-change executes in apply phase - // 4. view should be changed back to 'a' - ctrl.$$scope.$watch(function ngModelWatch() { - var modelValue = ctrl.$$ngModelGet(ctrl.$$scope); - - // if scope model value and ngModel value are out of sync - // TODO(perf): why not move this to the action fn? - if (modelValue !== ctrl.$modelValue && - // checks for NaN is needed to allow setting the model to NaN when there's an asyncValidator - // eslint-disable-next-line no-self-compare - (ctrl.$modelValue === ctrl.$modelValue || modelValue === modelValue) - ) { - ctrl.$modelValue = ctrl.$$rawModelValue = modelValue; - ctrl.$$parserValid = undefined; - - var formatters = ctrl.$formatters, - idx = formatters.length; - - var viewValue = modelValue; - while (idx--) { - viewValue = formatters[idx](viewValue); - } - if (ctrl.$viewValue !== viewValue) { - ctrl.$$updateEmptyClasses(viewValue); - ctrl.$viewValue = ctrl.$$lastCommittedViewValue = viewValue; - ctrl.$render(); - - // It is possible that model and view value have been updated during render - ctrl.$$runValidators(ctrl.$modelValue, ctrl.$viewValue, noop); - } - } - - return modelValue; - }); -} - -/** - * @ngdoc method - * @name ngModel.NgModelController#$setValidity - * - * @description - * Change the validity state, and notify the form. - * - * This method can be called within $parsers/$formatters or a custom validation implementation. - * However, in most cases it should be sufficient to use the `ngModel.$validators` and - * `ngModel.$asyncValidators` collections which will call `$setValidity` automatically. - * - * @param {string} validationErrorKey Name of the validator. The `validationErrorKey` will be assigned - * to either `$error[validationErrorKey]` or `$pending[validationErrorKey]` - * (for unfulfilled `$asyncValidators`), so that it is available for data-binding. - * The `validationErrorKey` should be in camelCase and will get converted into dash-case - * for class name. Example: `myError` will result in `ng-valid-my-error` and `ng-invalid-my-error` - * class and can be bound to as `{{someForm.someControl.$error.myError}}` . - * @param {boolean} isValid Whether the current state is valid (true), invalid (false), pending (undefined), - * or skipped (null). Pending is used for unfulfilled `$asyncValidators`. - * Skipped is used by Angular when validators do not run because of parse errors and - * when `$asyncValidators` do not run because any of the `$validators` failed. - */ -addSetValidityMethod({ - clazz: NgModelController, - set: function(object, property) { - object[property] = true; - }, - unset: function(object, property) { - delete object[property]; - } -}); - - -/** - * @ngdoc directive - * @name ngModel - * - * @element input - * @priority 1 - * - * @description - * The `ngModel` directive binds an `input`,`select`, `textarea` (or custom form control) to a - * property on the scope using {@link ngModel.NgModelController NgModelController}, - * which is created and exposed by this directive. - * - * `ngModel` is responsible for: - * - * - Binding the view into the model, which other directives such as `input`, `textarea` or `select` - * require. - * - Providing validation behavior (i.e. required, number, email, url). - * - Keeping the state of the control (valid/invalid, dirty/pristine, touched/untouched, validation errors). - * - Setting related css classes on the element (`ng-valid`, `ng-invalid`, `ng-dirty`, `ng-pristine`, `ng-touched`, - * `ng-untouched`, `ng-empty`, `ng-not-empty`) including animations. - * - Registering the control with its parent {@link ng.directive:form form}. - * - * Note: `ngModel` will try to bind to the property given by evaluating the expression on the - * current scope. If the property doesn't already exist on this scope, it will be created - * implicitly and added to the scope. - * - * For best practices on using `ngModel`, see: - * - * - [Understanding Scopes](https://github.com/angular/angular.js/wiki/Understanding-Scopes) - * - * For basic examples, how to use `ngModel`, see: - * - * - {@link ng.directive:input input} - * - {@link input[text] text} - * - {@link input[checkbox] checkbox} - * - {@link input[radio] radio} - * - {@link input[number] number} - * - {@link input[email] email} - * - {@link input[url] url} - * - {@link input[date] date} - * - {@link input[datetime-local] datetime-local} - * - {@link input[time] time} - * - {@link input[month] month} - * - {@link input[week] week} - * - {@link ng.directive:select select} - * - {@link ng.directive:textarea textarea} - * - * # Complex Models (objects or collections) - * - * By default, `ngModel` watches the model by reference, not value. This is important to know when - * binding inputs to models that are objects (e.g. `Date`) or collections (e.g. arrays). If only properties of the - * object or collection change, `ngModel` will not be notified and so the input will not be re-rendered. - * - * The model must be assigned an entirely new object or collection before a re-rendering will occur. - * - * Some directives have options that will cause them to use a custom `$watchCollection` on the model expression - * - for example, `ngOptions` will do so when a `track by` clause is included in the comprehension expression or - * if the select is given the `multiple` attribute. - * - * The `$watchCollection()` method only does a shallow comparison, meaning that changing properties deeper than the - * first level of the object (or only changing the properties of an item in the collection if it's an array) will still - * not trigger a re-rendering of the model. - * - * # CSS classes - * The following CSS classes are added and removed on the associated input/select/textarea element - * depending on the validity of the model. - * - * - `ng-valid`: the model is valid - * - `ng-invalid`: the model is invalid - * - `ng-valid-[key]`: for each valid key added by `$setValidity` - * - `ng-invalid-[key]`: for each invalid key added by `$setValidity` - * - `ng-pristine`: the control hasn't been interacted with yet - * - `ng-dirty`: the control has been interacted with - * - `ng-touched`: the control has been blurred - * - `ng-untouched`: the control hasn't been blurred - * - `ng-pending`: any `$asyncValidators` are unfulfilled - * - `ng-empty`: the view does not contain a value or the value is deemed "empty", as defined - * by the {@link ngModel.NgModelController#$isEmpty} method - * - `ng-not-empty`: the view contains a non-empty value - * - * Keep in mind that ngAnimate can detect each of these classes when added and removed. - * - * ## Animation Hooks - * - * Animations within models are triggered when any of the associated CSS classes are added and removed - * on the input element which is attached to the model. These classes include: `.ng-pristine`, `.ng-dirty`, - * `.ng-invalid` and `.ng-valid` as well as any other validations that are performed on the model itself. - * The animations that are triggered within ngModel are similar to how they work in ngClass and - * animations can be hooked into using CSS transitions, keyframes as well as JS animations. - * - * The following example shows a simple way to utilize CSS transitions to style an input element - * that has been rendered as invalid after it has been validated: - * - * 
- * //be sure to include ngAnimate as a module to hook into more
- * //advanced animations
- * .my-input {
- *   transition:0.5s linear all;
- *   background: white;
- * }
- * .my-input.ng-invalid {
- *   background: red;
- *   color:white;
- * }
- *
- * - * @example - * - - - -

- Update input to see transitions when valid/invalid. - Integer is a valid value. -

-
- -
- - * - * - * ## Binding to a getter/setter - * - * Sometimes it's helpful to bind `ngModel` to a getter/setter function. A getter/setter is a - * function that returns a representation of the model when called with zero arguments, and sets - * the internal state of a model when called with an argument. It's sometimes useful to use this - * for models that have an internal representation that's different from what the model exposes - * to the view. - * - *
- * **Best Practice:** It's best to keep getters fast because Angular is likely to call them more - * frequently than other parts of your code. - *
- * - * You use this behavior by adding `ng-model-options="{ getterSetter: true }"` to an element that - * has `ng-model` attached to it. You can also add `ng-model-options="{ getterSetter: true }"` to - * a `
`, which will enable this behavior for all ``s within it. See - * {@link ng.directive:ngModelOptions `ngModelOptions`} for more. - * - * The following example shows how to use `ngModel` with a getter/setter: - * - * @example - * - -
- - - - 
user.name =
-
- - - angular.module('getterSetterExample', []) - .controller('ExampleController', ['$scope', function($scope) { - var _name = 'Brian'; - $scope.user = { - name: function(newName) { - // Note that newName can be undefined for two reasons: - // 1. Because it is called as a getter and thus called with no arguments - // 2. Because the property should actually be set to undefined. This happens e.g. if the - // input is invalid - return arguments.length ? (_name = newName) : _name; - } - }; - }]); - - *
- */ -var ngModelDirective = ['$rootScope', function($rootScope) { - return { - restrict: 'A', - require: ['ngModel', '^?form', '^?ngModelOptions'], - controller: NgModelController, - // Prelink needs to run before any input directive - // so that we can set the NgModelOptions in NgModelController - // before anyone else uses it. - priority: 1, - compile: function ngModelCompile(element) { - // Setup initial state of the control - element.addClass(PRISTINE_CLASS).addClass(UNTOUCHED_CLASS).addClass(VALID_CLASS); - - return { - pre: function ngModelPreLink(scope, element, attr, ctrls) { - var modelCtrl = ctrls[0], - formCtrl = ctrls[1] || modelCtrl.$$parentForm, - optionsCtrl = ctrls[2]; - - if (optionsCtrl) { - modelCtrl.$options = optionsCtrl.$options; - } - - modelCtrl.$$initGetterSetters(); - - // notify others, especially parent forms - formCtrl.$addControl(modelCtrl); - - attr.$observe('name', function(newValue) { - if (modelCtrl.$name !== newValue) { - modelCtrl.$$parentForm.$$renameControl(modelCtrl, newValue); - } - }); - - scope.$on('$destroy', function() { - modelCtrl.$$parentForm.$removeControl(modelCtrl); - }); - }, - post: function ngModelPostLink(scope, element, attr, ctrls) { - var modelCtrl = ctrls[0]; - if (modelCtrl.$options.getOption('updateOn')) { - element.on(modelCtrl.$options.getOption('updateOn'), function(ev) { - modelCtrl.$$debounceViewValueCommit(ev && ev.type); - }); - } - - function setTouched() { - modelCtrl.$setTouched(); - } - - element.on('blur', function() { - if (modelCtrl.$touched) return; - - if ($rootScope.$$phase) { - scope.$evalAsync(setTouched); - } else { - scope.$apply(setTouched); - } - }); - } - }; - } - }; -}]; - -/* exported defaultModelOptions */ -var defaultModelOptions; -var DEFAULT_REGEXP = /(\s+|^)default(\s+|$)/; - -/** - * @ngdoc type - * @name ModelOptions - * @description - * A container for the options set by the {@link ngModelOptions} directive - */ -function ModelOptions(options) { - this.$$options = options; -} - -ModelOptions.prototype = { - - /** - * @ngdoc method - * @name ModelOptions#getOption - * @param {string} name the name of the option to retrieve - * @returns {*} the value of the option - * @description - * Returns the value of the given option - */ - getOption: function(name) { - return this.$$options[name]; - }, - - /** - * @ngdoc method - * @name ModelOptions#createChild - * @param {Object} options a hash of options for the new child that will override the parent's options - * @return {ModelOptions} a new `ModelOptions` object initialized with the given options. - */ - createChild: function(options) { - var inheritAll = false; - - // make a shallow copy - options = extend({}, options); - - // Inherit options from the parent if specified by the value `"$inherit"` - forEach(options, /* @this */ function(option, key) { - if (option === '$inherit') { - if (key === '*') { - inheritAll = true; - } else { - options[key] = this.$$options[key]; - // `updateOn` is special so we must also inherit the `updateOnDefault` option - if (key === 'updateOn') { - options.updateOnDefault = this.$$options.updateOnDefault; - } - } - } else { - if (key === 'updateOn') { - // If the `updateOn` property contains the `default` event then we have to remove - // it from the event list and set the `updateOnDefault` flag. - options.updateOnDefault = false; - options[key] = trim(option.replace(DEFAULT_REGEXP, function() { - options.updateOnDefault = true; - return ' '; - })); - } - } - }, this); - - if (inheritAll) { - // We have a property of the form: `"*": "$inherit"` - delete options['*']; - defaults(options, this.$$options); - } - - // Finally add in any missing defaults - defaults(options, defaultModelOptions.$$options); - - return new ModelOptions(options); - } -}; - - -defaultModelOptions = new ModelOptions({ - updateOn: '', - updateOnDefault: true, - debounce: 0, - getterSetter: false, - allowInvalid: false, - timezone: null -}); - - -/** - * @ngdoc directive - * @name ngModelOptions - * - * @description - * This directive allows you to modify the behaviour of {@link ngModel} directives within your - * application. You can specify an `ngModelOptions` directive on any element. All {@link ngModel} - * directives will use the options of their nearest `ngModelOptions` ancestor. - * - * The `ngModelOptions` settings are found by evaluating the value of the attribute directive as - * an Angular expression. This expression should evaluate to an object, whose properties contain - * the settings. For example: `
- *
- * - *
- *
- * ``` - * - * the `input` element will have the following settings - * - * ```js - * { allowInvalid: true, updateOn: 'default', debounce: 0 } - * ``` - * - * Notice that the `debounce` setting was not inherited and used the default value instead. - * - * You can specify that all undefined settings are automatically inherited from an ancestor by - * including a property with key of `"*"` and value of `"$inherit"`. - * - * For example given the following fragment of HTML - * - * - * ```html - *
- *
- * - *
- *
- * ``` - * - * the `input` element will have the following settings - * - * ```js - * { allowInvalid: true, updateOn: 'default', debounce: 200 } - * ``` - * - * Notice that the `debounce` setting now inherits the value from the outer `
` element. - * - * If you are creating a reusable component then you should be careful when using `"*": "$inherit"` - * since you may inadvertently inherit a setting in the future that changes the behavior of your component. - * - * - * ## Triggering and debouncing model updates - * - * The `updateOn` and `debounce` properties allow you to specify a custom list of events that will - * trigger a model update and/or a debouncing delay so that the actual update only takes place when - * a timer expires; this timer will be reset after another change takes place. - * - * Given the nature of `ngModelOptions`, the value displayed inside input fields in the view might - * be different from the value in the actual model. This means that if you update the model you - * should also invoke {@link ngModel.NgModelController#$rollbackViewValue} on the relevant input field in - * order to make sure it is synchronized with the model and that any debounced action is canceled. - * - * The easiest way to reference the control's {@link ngModel.NgModelController#$rollbackViewValue} - * method is by making sure the input is placed inside a form that has a `name` attribute. This is - * important because `form` controllers are published to the related scope under the name in their - * `name` attribute. - * - * Any pending changes will take place immediately when an enclosing form is submitted via the - * `submit` event. Note that `ngClick` events will occur before the model is updated. Use `ngSubmit` - * to have access to the updated model. - * - * The following example shows how to override immediate updates. Changes on the inputs within the - * form will update the model only when the control loses focus (blur event). If `escape` key is - * pressed while the input field is focused, the value is reset to the value in the current model. - * - * - * - *
- *
- *
- *
- *
- * 
user.name =
- *
- * - * - * angular.module('optionsExample', []) - * .controller('ExampleController', ['$scope', function($scope) { - * $scope.user = { name: 'say', data: '' }; - * - * $scope.cancel = function(e) { - * if (e.keyCode === 27) { - * $scope.userForm.userName.$rollbackViewValue(); - * } - * }; - * }]); - * - * - * var model = element(by.binding('user.name')); - * var input = element(by.model('user.name')); - * var other = element(by.model('user.data')); - * - * it('should allow custom events', function() { - * input.sendKeys(' hello'); - * input.click(); - * expect(model.getText()).toEqual('say'); - * other.click(); - * expect(model.getText()).toEqual('say hello'); - * }); - * - * it('should $rollbackViewValue when model changes', function() { - * input.sendKeys(' hello'); - * expect(input.getAttribute('value')).toEqual('say hello'); - * input.sendKeys(protractor.Key.ESCAPE); - * expect(input.getAttribute('value')).toEqual('say'); - * other.click(); - * expect(model.getText()).toEqual('say'); - * }); - * - * - * - * The next example shows how to debounce model changes. Model will be updated only 1 sec after last change. - * If the `Clear` button is pressed, any debounced action is canceled and the value becomes empty. - * - * - * - *
- *
- * Name: - * - *
- *
- * 
user.name =
- *
- * - * - * angular.module('optionsExample', []) - * .controller('ExampleController', ['$scope', function($scope) { - * $scope.user = { name: 'say' }; - * }]); - * - * - * - * ## Model updates and validation - * - * The default behaviour in `ngModel` is that the model value is set to `undefined` when the - * validation determines that the value is invalid. By setting the `allowInvalid` property to true, - * the model will still be updated even if the value is invalid. - * - * - * ## Connecting to the scope - * - * By setting the `getterSetter` property to true you are telling ngModel that the `ngModel` expression - * on the scope refers to a "getter/setter" function rather than the value itself. - * - * The following example shows how to bind to getter/setters: - * - * - * - *
- *
- * - *
- * 
user.name =
- *
- * - * - * angular.module('getterSetterExample', []) - * .controller('ExampleController', ['$scope', function($scope) { - * var _name = 'Brian'; - * $scope.user = { - * name: function(newName) { - * return angular.isDefined(newName) ? (_name = newName) : _name; - * } - * }; - * }]); - * - * - * - * - * ## Specifying timezones - * - * You can specify the timezone that date/time input directives expect by providing its name in the - * `timezone` property. - * - * @param {Object} ngModelOptions options to apply to {@link ngModel} directives on this element and - * and its descendents. Valid keys are: - * - `updateOn`: string specifying which event should the input be bound to. You can set several - * events using an space delimited list. There is a special event called `default` that - * matches the default events belonging to the control. - * - `debounce`: integer value which contains the debounce model update value in milliseconds. A - * value of 0 triggers an immediate update. If an object is supplied instead, you can specify a - * custom value for each event. For example: - * ``` - * ng-model-options="{ - * updateOn: 'default blur', - * debounce: { 'default': 500, 'blur': 0 } - * }" - * ``` - * - `allowInvalid`: boolean value which indicates that the model can be set with values that did - * not validate correctly instead of the default behavior of setting the model to undefined. - * - `getterSetter`: boolean value which determines whether or not to treat functions bound to - * `ngModel` as getters/setters. - * - `timezone`: Defines the timezone to be used to read/write the `Date` instance in the model for - * ``, ``, ... . It understands UTC/GMT and the - * continental US time zone abbreviations, but for general use, use a time zone offset, for - * example, `'+0430'` (4 hours, 30 minutes east of the Greenwich meridian) - * If not specified, the timezone of the browser will be used. - * - */ -var ngModelOptionsDirective = function() { - return { - restrict: 'A', - // ngModelOptions needs to run before ngModel and input directives - priority: 10, - require: ['ngModelOptions', '?^^ngModelOptions'], - controller: function NgModelOptionsController() {}, - link: { - pre: function ngModelOptionsPreLinkFn(scope, element, attrs, ctrls) { - var optionsCtrl = ctrls[0]; - var parentOptions = ctrls[1] ? ctrls[1].$options : defaultModelOptions; - optionsCtrl.$options = parentOptions.createChild(scope.$eval(attrs.ngModelOptions)); - } - } - }; -}; - - -// shallow copy over values from `src` that are not already specified on `dst` -function defaults(dst, src) { - forEach(src, function(value, key) { - if (!isDefined(dst[key])) { - dst[key] = value; - } - }); -} - -/** - * @ngdoc directive - * @name ngNonBindable - * @restrict AC - * @priority 1000 - * - * @description - * The `ngNonBindable` directive tells Angular not to compile or bind the contents of the current - * DOM element. This is useful if the element contains what appears to be Angular directives and - * bindings but which should be ignored by Angular. This could be the case if you have a site that - * displays snippets of code, for instance. - * - * @element ANY - * - * @example - * In this example there are two locations where a simple interpolation binding (`{{}}`) is present, - * but the one wrapped in `ngNonBindable` is left alone. - * - * @example - - -
Normal: {{1 + 2}}
-
Ignored: {{1 + 2}}
- - - it('should check ng-non-bindable', function() { - expect(element(by.binding('1 + 2')).getText()).toContain('3'); - expect(element.all(by.css('div')).last().getText()).toMatch(/1 \+ 2/); - }); - - - */ -var ngNonBindableDirective = ngDirective({ terminal: true, priority: 1000 }); - -/* exported ngOptionsDirective */ - -/* global jqLiteRemove */ - -var ngOptionsMinErr = minErr('ngOptions'); - -/** - * @ngdoc directive - * @name ngOptions - * @restrict A - * - * @description - * - * The `ngOptions` attribute can be used to dynamically generate a list of `` - * DOM element. - * * `disable`: The result of this expression will be used to disable the rendered `
- - - it('should show correct pluralized string', function() { - var withoutOffset = element.all(by.css('ng-pluralize')).get(0); - var withOffset = element.all(by.css('ng-pluralize')).get(1); - var countInput = element(by.model('personCount')); - - expect(withoutOffset.getText()).toEqual('1 person is viewing.'); - expect(withOffset.getText()).toEqual('Igor is viewing.'); - - countInput.clear(); - countInput.sendKeys('0'); - - expect(withoutOffset.getText()).toEqual('Nobody is viewing.'); - expect(withOffset.getText()).toEqual('Nobody is viewing.'); - - countInput.clear(); - countInput.sendKeys('2'); - - expect(withoutOffset.getText()).toEqual('2 people are viewing.'); - expect(withOffset.getText()).toEqual('Igor and Misko are viewing.'); - - countInput.clear(); - countInput.sendKeys('3'); - - expect(withoutOffset.getText()).toEqual('3 people are viewing.'); - expect(withOffset.getText()).toEqual('Igor, Misko and one other person are viewing.'); - - countInput.clear(); - countInput.sendKeys('4'); - - expect(withoutOffset.getText()).toEqual('4 people are viewing.'); - expect(withOffset.getText()).toEqual('Igor, Misko and 2 other people are viewing.'); - }); - it('should show data-bound names', function() { - var withOffset = element.all(by.css('ng-pluralize')).get(1); - var personCount = element(by.model('personCount')); - var person1 = element(by.model('person1')); - var person2 = element(by.model('person2')); - personCount.clear(); - personCount.sendKeys('4'); - person1.clear(); - person1.sendKeys('Di'); - person2.clear(); - person2.sendKeys('Vojta'); - expect(withOffset.getText()).toEqual('Di, Vojta and 2 other people are viewing.'); - }); - - - */ -var ngPluralizeDirective = ['$locale', '$interpolate', '$log', function($locale, $interpolate, $log) { - var BRACE = /{}/g, - IS_WHEN = /^when(Minus)?(.+)$/; - - return { - link: function(scope, element, attr) { - var numberExp = attr.count, - whenExp = attr.$attr.when && element.attr(attr.$attr.when), // we have {{}} in attrs - offset = attr.offset || 0, - whens = scope.$eval(whenExp) || {}, - whensExpFns = {}, - startSymbol = $interpolate.startSymbol(), - endSymbol = $interpolate.endSymbol(), - braceReplacement = startSymbol + numberExp + '-' + offset + endSymbol, - watchRemover = angular.noop, - lastCount; - - forEach(attr, function(expression, attributeName) { - var tmpMatch = IS_WHEN.exec(attributeName); - if (tmpMatch) { - var whenKey = (tmpMatch[1] ? '-' : '') + lowercase(tmpMatch[2]); - whens[whenKey] = element.attr(attr.$attr[attributeName]); - } - }); - forEach(whens, function(expression, key) { - whensExpFns[key] = $interpolate(expression.replace(BRACE, braceReplacement)); - - }); - - scope.$watch(numberExp, function ngPluralizeWatchAction(newVal) { - var count = parseFloat(newVal); - var countIsNaN = isNumberNaN(count); - - if (!countIsNaN && !(count in whens)) { - // If an explicit number rule such as 1, 2, 3... is defined, just use it. - // Otherwise, check it against pluralization rules in $locale service. - count = $locale.pluralCat(count - offset); - } - - // If both `count` and `lastCount` are NaN, we don't need to re-register a watch. - // In JS `NaN !== NaN`, so we have to explicitly check. - if ((count !== lastCount) && !(countIsNaN && isNumberNaN(lastCount))) { - watchRemover(); - var whenExpFn = whensExpFns[count]; - if (isUndefined(whenExpFn)) { - if (newVal != null) { - $log.debug('ngPluralize: no rule defined for \'' + count + '\' in ' + whenExp); - } - watchRemover = noop; - updateElementText(); - } else { - watchRemover = scope.$watch(whenExpFn, updateElementText); - } - lastCount = count; - } - }); - - function updateElementText(newText) { - element.text(newText || ''); - } - } - }; -}]; - -/* exported ngRepeatDirective */ - -/** - * @ngdoc directive - * @name ngRepeat - * @multiElement - * - * @description - * The `ngRepeat` directive instantiates a template once per item from a collection. Each template - * instance gets its own scope, where the given loop variable is set to the current collection item, - * and `$index` is set to the item index or key. - * - * Special properties are exposed on the local scope of each template instance, including: - * - * | Variable | Type | Details | - * |-----------|-----------------|-----------------------------------------------------------------------------| - * | `$index` | {@type number} | iterator offset of the repeated element (0..length-1) | - * | `$first` | {@type boolean} | true if the repeated element is first in the iterator. | - * | `$middle` | {@type boolean} | true if the repeated element is between the first and last in the iterator. | - * | `$last` | {@type boolean} | true if the repeated element is last in the iterator. | - * | `$even` | {@type boolean} | true if the iterator position `$index` is even (otherwise false). | - * | `$odd` | {@type boolean} | true if the iterator position `$index` is odd (otherwise false). | - * - *
- * Creating aliases for these properties is possible with {@link ng.directive:ngInit `ngInit`}. - * This may be useful when, for instance, nesting ngRepeats. - *
- * - * - * # Iterating over object properties - * - * It is possible to get `ngRepeat` to iterate over the properties of an object using the following - * syntax: - * - * ```js - *
...
- * ``` - * - * However, there are a few limitations compared to array iteration: - * - * - The JavaScript specification does not define the order of keys - * returned for an object, so Angular relies on the order returned by the browser - * when running `for key in myObj`. Browsers generally follow the strategy of providing - * keys in the order in which they were defined, although there are exceptions when keys are deleted - * and reinstated. See the - * [MDN page on `delete` for more info](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/delete#Cross-browser_notes). - * - * - `ngRepeat` will silently *ignore* object keys starting with `$`, because - * it's a prefix used by Angular for public (`$`) and private (`$$`) properties. - * - * - The built-in filters {@link ng.orderBy orderBy} and {@link ng.filter filter} do not work with - * objects, and will throw an error if used with one. - * - * If you are hitting any of these limitations, the recommended workaround is to convert your object into an array - * that is sorted into the order that you prefer before providing it to `ngRepeat`. You could - * do this with a filter such as [toArrayFilter](http://ngmodules.org/modules/angular-toArrayFilter) - * or implement a `$watch` on the object yourself. - * - * - * # Tracking and Duplicates - * - * `ngRepeat` uses {@link $rootScope.Scope#$watchCollection $watchCollection} to detect changes in - * the collection. When a change happens, `ngRepeat` then makes the corresponding changes to the DOM: - * - * * When an item is added, a new instance of the template is added to the DOM. - * * When an item is removed, its template instance is removed from the DOM. - * * When items are reordered, their respective templates are reordered in the DOM. - * - * To minimize creation of DOM elements, `ngRepeat` uses a function - * to "keep track" of all items in the collection and their corresponding DOM elements. - * For example, if an item is added to the collection, `ngRepeat` will know that all other items - * already have DOM elements, and will not re-render them. - * - * The default tracking function (which tracks items by their identity) does not allow - * duplicate items in arrays. This is because when there are duplicates, it is not possible - * to maintain a one-to-one mapping between collection items and DOM elements. - * - * If you do need to repeat duplicate items, you can substitute the default tracking behavior - * with your own using the `track by` expression. - * - * For example, you may track items by the index of each item in the collection, using the - * special scope property `$index`: - * ```html - *
- * {{n}} - *
- * ``` - * - * You may also use arbitrary expressions in `track by`, including references to custom functions - * on the scope: - * ```html - *
- * {{n}} - *
- * ``` - * - *
- * If you are working with objects that have a unique identifier property, you should track - * by this identifier instead of the object instance. Should you reload your data later, `ngRepeat` - * will not have to rebuild the DOM elements for items it has already rendered, even if the - * JavaScript objects in the collection have been substituted for new ones. For large collections, - * this significantly improves rendering performance. If you don't have a unique identifier, - * `track by $index` can also provide a performance boost. - *
- * - * ```html - *
- * {{model.name}} - *
- * ``` - * - *
- *
- * Avoid using `track by $index` when the repeated template contains - * {@link guide/expression#one-time-binding one-time bindings}. In such cases, the `nth` DOM - * element will always be matched with the `nth` item of the array, so the bindings on that element - * will not be updated even when the corresponding item changes, essentially causing the view to get - * out-of-sync with the underlying data. - *
- * - * When no `track by` expression is provided, it is equivalent to tracking by the built-in - * `$id` function, which tracks items by their identity: - * ```html - *
- * {{obj.prop}} - *
- * ``` - * - *
- *
- * **Note:** `track by` must always be the last expression: - *
- * ``` - *
- * {{model.name}} - *
- * ``` - * - * - * # Special repeat start and end points - * To repeat a series of elements instead of just one parent element, ngRepeat (as well as other ng directives) supports extending - * the range of the repeater by defining explicit start and end points by using **ng-repeat-start** and **ng-repeat-end** respectively. - * The **ng-repeat-start** directive works the same as **ng-repeat**, but will repeat all the HTML code (including the tag it's defined on) - * up to and including the ending HTML tag where **ng-repeat-end** is placed. - * - * The example below makes use of this feature: - * ```html - *
- * Header {{ item }} - *
- *
- * Body {{ item }} - *
- *
- * Footer {{ item }} - *
- * ``` - * - * And with an input of {@type ['A','B']} for the items variable in the example above, the output will evaluate to: - * ```html - *
- * Header A - *
- *
- * Body A - *
- *
- * Footer A - *
- *
- * Header B - *
- *
- * Body B - *
- *
- * Footer B - *
- * ``` - * - * The custom start and end points for ngRepeat also support all other HTML directive syntax flavors provided in AngularJS (such - * as **data-ng-repeat-start**, **x-ng-repeat-start** and **ng:repeat-start**). - * - * @animations - * | Animation | Occurs | - * |----------------------------------|-------------------------------------| - * | {@link ng.$animate#enter enter} | when a new item is added to the list or when an item is revealed after a filter | - * | {@link ng.$animate#leave leave} | when an item is removed from the list or when an item is filtered out | - * | {@link ng.$animate#move move } | when an adjacent item is filtered out causing a reorder or when the item contents are reordered | - * - * See the example below for defining CSS animations with ngRepeat. - * - * @element ANY - * @scope - * @priority 1000 - * @param {repeat_expression} ngRepeat The expression indicating how to enumerate a collection. These - * formats are currently supported: - * - * * `variable in expression` – where variable is the user defined loop variable and `expression` - * is a scope expression giving the collection to enumerate. - * - * For example: `album in artist.albums`. - * - * * `(key, value) in expression` – where `key` and `value` can be any user defined identifiers, - * and `expression` is the scope expression giving the collection to enumerate. - * - * For example: `(name, age) in {'adam':10, 'amalie':12}`. - * - * * `variable in expression track by tracking_expression` – You can also provide an optional tracking expression - * which can be used to associate the objects in the collection with the DOM elements. If no tracking expression - * is specified, ng-repeat associates elements by identity. It is an error to have - * more than one tracking expression value resolve to the same key. (This would mean that two distinct objects are - * mapped to the same DOM element, which is not possible.) - * - * Note that the tracking expression must come last, after any filters, and the alias expression. - * - * For example: `item in items` is equivalent to `item in items track by $id(item)`. This implies that the DOM elements - * will be associated by item identity in the array. - * - * For example: `item in items track by $id(item)`. A built in `$id()` function can be used to assign a unique - * `$$hashKey` property to each item in the array. This property is then used as a key to associated DOM elements - * with the corresponding item in the array by identity. Moving the same object in array would move the DOM - * element in the same way in the DOM. - * - * For example: `item in items track by item.id` is a typical pattern when the items come from the database. In this - * case the object identity does not matter. Two objects are considered equivalent as long as their `id` - * property is same. - * - * For example: `item in items | filter:searchText track by item.id` is a pattern that might be used to apply a filter - * to items in conjunction with a tracking expression. - * - * * `variable in expression as alias_expression` – You can also provide an optional alias expression which will then store the - * intermediate results of the repeater after the filters have been applied. Typically this is used to render a special message - * when a filter is active on the repeater, but the filtered result set is empty. - * - * For example: `item in items | filter:x as results` will store the fragment of the repeated items as `results`, but only after - * the items have been processed through the filter. - * - * Please note that `as [variable name] is not an operator but rather a part of ngRepeat micro-syntax so it can be used only at the end - * (and not as operator, inside an expression). - * - * For example: `item in items | filter : x | orderBy : order | limitTo : limit as results` . - * - * @example - * This example uses `ngRepeat` to display a list of people. A filter is used to restrict the displayed - * results by name or by age. New (entering) and removed (leaving) items are animated. - - -
- I have {{friends.length}} friends. They are: - -
    -
  • - [{{$index + 1}}] {{friend.name}} who is {{friend.age}} years old. -
    • -
  • - No results found... -
    • -
-
- - - angular.module('ngRepeat', ['ngAnimate']).controller('repeatController', function($scope) { - $scope.friends = [ - {name:'John', age:25, gender:'boy'}, - {name:'Jessie', age:30, gender:'girl'}, - {name:'Johanna', age:28, gender:'girl'}, - {name:'Joy', age:15, gender:'girl'}, - {name:'Mary', age:28, gender:'girl'}, - {name:'Peter', age:95, gender:'boy'}, - {name:'Sebastian', age:50, gender:'boy'}, - {name:'Erika', age:27, gender:'girl'}, - {name:'Patrick', age:40, gender:'boy'}, - {name:'Samantha', age:60, gender:'girl'} - ]; - }); - - - .example-animate-container { - background:white; - border:1px solid black; - list-style:none; - margin:0; - padding:0 10px; - } - - .animate-repeat { - line-height:30px; - list-style:none; - box-sizing:border-box; - } - - .animate-repeat.ng-move, - .animate-repeat.ng-enter, - .animate-repeat.ng-leave { - transition:all linear 0.5s; - } - - .animate-repeat.ng-leave.ng-leave-active, - .animate-repeat.ng-move, - .animate-repeat.ng-enter { - opacity:0; - max-height:0; - } - - .animate-repeat.ng-leave, - .animate-repeat.ng-move.ng-move-active, - .animate-repeat.ng-enter.ng-enter-active { - opacity:1; - max-height:30px; - } - - - var friends = element.all(by.repeater('friend in friends')); - - it('should render initial data set', function() { - expect(friends.count()).toBe(10); - expect(friends.get(0).getText()).toEqual('[1] John who is 25 years old.'); - expect(friends.get(1).getText()).toEqual('[2] Jessie who is 30 years old.'); - expect(friends.last().getText()).toEqual('[10] Samantha who is 60 years old.'); - expect(element(by.binding('friends.length')).getText()) - .toMatch("I have 10 friends. They are:"); - }); - - it('should update repeater when filter predicate changes', function() { - expect(friends.count()).toBe(10); - - element(by.model('q')).sendKeys('ma'); - - expect(friends.count()).toBe(2); - expect(friends.get(0).getText()).toEqual('[1] Mary who is 28 years old.'); - expect(friends.last().getText()).toEqual('[2] Samantha who is 60 years old.'); - }); - - - */ -var ngRepeatDirective = ['$parse', '$animate', '$compile', function($parse, $animate, $compile) { - var NG_REMOVED = '$$NG_REMOVED'; - var ngRepeatMinErr = minErr('ngRepeat'); - - var updateScope = function(scope, index, valueIdentifier, value, keyIdentifier, key, arrayLength) { - // TODO(perf): generate setters to shave off ~40ms or 1-1.5% - scope[valueIdentifier] = value; - if (keyIdentifier) scope[keyIdentifier] = key; - scope.$index = index; - scope.$first = (index === 0); - scope.$last = (index === (arrayLength - 1)); - scope.$middle = !(scope.$first || scope.$last); - // eslint-disable-next-line no-bitwise - scope.$odd = !(scope.$even = (index & 1) === 0); - }; - - var getBlockStart = function(block) { - return block.clone[0]; - }; - - var getBlockEnd = function(block) { - return block.clone[block.clone.length - 1]; - }; - - - return { - restrict: 'A', - multiElement: true, - transclude: 'element', - priority: 1000, - terminal: true, - $$tlb: true, - compile: function ngRepeatCompile($element, $attr) { - var expression = $attr.ngRepeat; - var ngRepeatEndComment = $compile.$$createComment('end ngRepeat', expression); - - var match = expression.match(/^\s*([\s\S]+?)\s+in\s+([\s\S]+?)(?:\s+as\s+([\s\S]+?))?(?:\s+track\s+by\s+([\s\S]+?))?\s*$/); - - if (!match) { - throw ngRepeatMinErr('iexp', 'Expected expression in form of \'_item_ in _collection_[ track by _id_]\' but got \'{0}\'.', - expression); - } - - var lhs = match[1]; - var rhs = match[2]; - var aliasAs = match[3]; - var trackByExp = match[4]; - - match = lhs.match(/^(?:(\s*[$\w]+)|\(\s*([$\w]+)\s*,\s*([$\w]+)\s*\))$/); - - if (!match) { - throw ngRepeatMinErr('iidexp', '\'_item_\' in \'_item_ in _collection_\' should be an identifier or \'(_key_, _value_)\' expression, but got \'{0}\'.', - lhs); - } - var valueIdentifier = match[3] || match[1]; - var keyIdentifier = match[2]; - - if (aliasAs && (!/^[$a-zA-Z_][$a-zA-Z0-9_]*$/.test(aliasAs) || - /^(null|undefined|this|\$index|\$first|\$middle|\$last|\$even|\$odd|\$parent|\$root|\$id)$/.test(aliasAs))) { - throw ngRepeatMinErr('badident', 'alias \'{0}\' is invalid --- must be a valid JS identifier which is not a reserved name.', - aliasAs); - } - - var trackByExpGetter, trackByIdExpFn, trackByIdArrayFn, trackByIdObjFn; - var hashFnLocals = {$id: hashKey}; - - if (trackByExp) { - trackByExpGetter = $parse(trackByExp); - } else { - trackByIdArrayFn = function(key, value) { - return hashKey(value); - }; - trackByIdObjFn = function(key) { - return key; - }; - } - - return function ngRepeatLink($scope, $element, $attr, ctrl, $transclude) { - - if (trackByExpGetter) { - trackByIdExpFn = function(key, value, index) { - // assign key, value, and $index to the locals so that they can be used in hash functions - if (keyIdentifier) hashFnLocals[keyIdentifier] = key; - hashFnLocals[valueIdentifier] = value; - hashFnLocals.$index = index; - return trackByExpGetter($scope, hashFnLocals); - }; - } - - // Store a list of elements from previous run. This is a hash where key is the item from the - // iterator, and the value is objects with following properties. - // - scope: bound scope - // - element: previous element. - // - index: position - // - // We are using no-proto object so that we don't need to guard against inherited props via - // hasOwnProperty. - var lastBlockMap = createMap(); - - //watch props - $scope.$watchCollection(rhs, function ngRepeatAction(collection) { - var index, length, - previousNode = $element[0], // node that cloned nodes should be inserted after - // initialized to the comment node anchor - nextNode, - // Same as lastBlockMap but it has the current state. It will become the - // lastBlockMap on the next iteration. - nextBlockMap = createMap(), - collectionLength, - key, value, // key/value of iteration - trackById, - trackByIdFn, - collectionKeys, - block, // last object information {scope, element, id} - nextBlockOrder, - elementsToRemove; - - if (aliasAs) { - $scope[aliasAs] = collection; - } - - if (isArrayLike(collection)) { - collectionKeys = collection; - trackByIdFn = trackByIdExpFn || trackByIdArrayFn; - } else { - trackByIdFn = trackByIdExpFn || trackByIdObjFn; - // if object, extract keys, in enumeration order, unsorted - collectionKeys = []; - for (var itemKey in collection) { - if (hasOwnProperty.call(collection, itemKey) && itemKey.charAt(0) !== '$') { - collectionKeys.push(itemKey); - } - } - } - - collectionLength = collectionKeys.length; - nextBlockOrder = new Array(collectionLength); - - // locate existing items - for (index = 0; index < collectionLength; index++) { - key = (collection === collectionKeys) ? index : collectionKeys[index]; - value = collection[key]; - trackById = trackByIdFn(key, value, index); - if (lastBlockMap[trackById]) { - // found previously seen block - block = lastBlockMap[trackById]; - delete lastBlockMap[trackById]; - nextBlockMap[trackById] = block; - nextBlockOrder[index] = block; - } else if (nextBlockMap[trackById]) { - // if collision detected. restore lastBlockMap and throw an error - forEach(nextBlockOrder, function(block) { - if (block && block.scope) lastBlockMap[block.id] = block; - }); - throw ngRepeatMinErr('dupes', - 'Duplicates in a repeater are not allowed. Use \'track by\' expression to specify unique keys. Repeater: {0}, Duplicate key: {1}, Duplicate value: {2}', - expression, trackById, value); - } else { - // new never before seen block - nextBlockOrder[index] = {id: trackById, scope: undefined, clone: undefined}; - nextBlockMap[trackById] = true; - } - } - - // remove leftover items - for (var blockKey in lastBlockMap) { - block = lastBlockMap[blockKey]; - elementsToRemove = getBlockNodes(block.clone); - $animate.leave(elementsToRemove); - if (elementsToRemove[0].parentNode) { - // if the element was not removed yet because of pending animation, mark it as deleted - // so that we can ignore it later - for (index = 0, length = elementsToRemove.length; index < length; index++) { - elementsToRemove[index][NG_REMOVED] = true; - } - } - block.scope.$destroy(); - } - - // we are not using forEach for perf reasons (trying to avoid #call) - for (index = 0; index < collectionLength; index++) { - key = (collection === collectionKeys) ? index : collectionKeys[index]; - value = collection[key]; - block = nextBlockOrder[index]; - - if (block.scope) { - // if we have already seen this object, then we need to reuse the - // associated scope/element - - nextNode = previousNode; - - // skip nodes that are already pending removal via leave animation - do { - nextNode = nextNode.nextSibling; - } while (nextNode && nextNode[NG_REMOVED]); - - if (getBlockStart(block) !== nextNode) { - // existing item which got moved - $animate.move(getBlockNodes(block.clone), null, previousNode); - } - previousNode = getBlockEnd(block); - updateScope(block.scope, index, valueIdentifier, value, keyIdentifier, key, collectionLength); - } else { - // new item which we don't know about - $transclude(function ngRepeatTransclude(clone, scope) { - block.scope = scope; - // http://jsperf.com/clone-vs-createcomment - var endNode = ngRepeatEndComment.cloneNode(false); - clone[clone.length++] = endNode; - - $animate.enter(clone, null, previousNode); - previousNode = endNode; - // Note: We only need the first/last node of the cloned nodes. - // However, we need to keep the reference to the jqlite wrapper as it might be changed later - // by a directive with templateUrl when its template arrives. - block.clone = clone; - nextBlockMap[block.id] = block; - updateScope(block.scope, index, valueIdentifier, value, keyIdentifier, key, collectionLength); - }); - } - } - lastBlockMap = nextBlockMap; - }); - }; - } - }; -}]; - -var NG_HIDE_CLASS = 'ng-hide'; -var NG_HIDE_IN_PROGRESS_CLASS = 'ng-hide-animate'; -/** - * @ngdoc directive - * @name ngShow - * @multiElement - * - * @description - * The `ngShow` directive shows or hides the given HTML element based on the expression - * provided to the `ngShow` attribute. The element is shown or hidden by removing or adding - * the `.ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined - * in AngularJS and sets the display style to none (using an !important flag). - * For CSP mode please add `angular-csp.css` to your html file (see {@link ng.directive:ngCsp ngCsp}). - * - * ```html - * - *
- * - * - *
- * ``` - * - * When the `ngShow` expression evaluates to a falsy value then the `.ng-hide` CSS class is added to the class - * attribute on the element causing it to become hidden. When truthy, the `.ng-hide` CSS class is removed - * from the element causing the element not to appear hidden. - * - * ## Why is !important used? - * - * You may be wondering why !important is used for the `.ng-hide` CSS class. This is because the `.ng-hide` selector - * can be easily overridden by heavier selectors. For example, something as simple - * as changing the display style on a HTML list item would make hidden elements appear visible. - * This also becomes a bigger issue when dealing with CSS frameworks. - * - * By using !important, the show and hide behavior will work as expected despite any clash between CSS selector - * specificity (when !important isn't used with any conflicting styles). If a developer chooses to override the - * styling to change how to hide an element then it is just a matter of using !important in their own CSS code. - * - * ### Overriding `.ng-hide` - * - * By default, the `.ng-hide` class will style the element with `display: none!important`. If you wish to change - * the hide behavior with ngShow/ngHide then this can be achieved by restating the styles for the `.ng-hide` - * class CSS. Note that the selector that needs to be used is actually `.ng-hide:not(.ng-hide-animate)` to cope - * with extra animation classes that can be added. - * - * ```css - * .ng-hide:not(.ng-hide-animate) { - * /* this is just another form of hiding an element */ - * display: block!important; - * position: absolute; - * top: -9999px; - * left: -9999px; - * } - * ``` - * - * By default you don't need to override in CSS anything and the animations will work around the display style. - * - * ## A note about animations with `ngShow` - * - * Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression - * is true and false. This system works like the animation system present with ngClass except that - * you must also include the !important flag to override the display property - * so that you can perform an animation when the element is hidden during the time of the animation. - * - * ```css - * // - * //a working example can be found at the bottom of this page - * // - * .my-element.ng-hide-add, .my-element.ng-hide-remove { - * /* this is required as of 1.3x to properly - * apply all styling in a show/hide animation */ - * transition: 0s linear all; - * } - * - * .my-element.ng-hide-add-active, - * .my-element.ng-hide-remove-active { - * /* the transition is defined in the active class */ - * transition: 1s linear all; - * } - * - * .my-element.ng-hide-add { ... } - * .my-element.ng-hide-add.ng-hide-add-active { ... } - * .my-element.ng-hide-remove { ... } - * .my-element.ng-hide-remove.ng-hide-remove-active { ... } - * ``` - * - * Keep in mind that, as of AngularJS version 1.3, there is no need to change the display - * property to block during animation states--ngAnimate will handle the style toggling automatically for you. - * - * @animations - * | Animation | Occurs | - * |----------------------------------|-------------------------------------| - * | {@link $animate#addClass addClass} `.ng-hide` | after the `ngShow` expression evaluates to a non truthy value and just before the contents are set to hidden | - * | {@link $animate#removeClass removeClass} `.ng-hide` | after the `ngShow` expression evaluates to a truthy value and just before contents are set to visible | - * - * @element ANY - * @param {expression} ngShow If the {@link guide/expression expression} is truthy - * then the element is shown or hidden respectively. - * - * @example - - - Click me:
-
- Show: -
- I show up when your checkbox is checked. -
-
-
- Hide: -
- I hide when your checkbox is checked. -
-
- - - @import url(../../components/bootstrap-3.1.1/css/bootstrap.css); - - - .animate-show { - line-height: 20px; - opacity: 1; - padding: 10px; - border: 1px solid black; - background: white; - } - - .animate-show.ng-hide-add, .animate-show.ng-hide-remove { - transition: all linear 0.5s; - } - - .animate-show.ng-hide { - line-height: 0; - opacity: 0; - padding: 0 10px; - } - - .check-element { - padding: 10px; - border: 1px solid black; - background: white; - } - - - var thumbsUp = element(by.css('span.glyphicon-thumbs-up')); - var thumbsDown = element(by.css('span.glyphicon-thumbs-down')); - - it('should check ng-show / ng-hide', function() { - expect(thumbsUp.isDisplayed()).toBeFalsy(); - expect(thumbsDown.isDisplayed()).toBeTruthy(); - - element(by.model('checked')).click(); - - expect(thumbsUp.isDisplayed()).toBeTruthy(); - expect(thumbsDown.isDisplayed()).toBeFalsy(); - }); - - - */ -var ngShowDirective = ['$animate', function($animate) { - return { - restrict: 'A', - multiElement: true, - link: function(scope, element, attr) { - scope.$watch(attr.ngShow, function ngShowWatchAction(value) { - // we're adding a temporary, animation-specific class for ng-hide since this way - // we can control when the element is actually displayed on screen without having - // to have a global/greedy CSS selector that breaks when other animations are run. - // Read: https://github.com/angular/angular.js/issues/9103#issuecomment-58335845 - $animate[value ? 'removeClass' : 'addClass'](element, NG_HIDE_CLASS, { - tempClasses: NG_HIDE_IN_PROGRESS_CLASS - }); - }); - } - }; -}]; - - -/** - * @ngdoc directive - * @name ngHide - * @multiElement - * - * @description - * The `ngHide` directive shows or hides the given HTML element based on the expression - * provided to the `ngHide` attribute. The element is shown or hidden by removing or adding - * the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined - * in AngularJS and sets the display style to none (using an !important flag). - * For CSP mode please add `angular-csp.css` to your html file (see {@link ng.directive:ngCsp ngCsp}). - * - * ```html - * - *
- * - * - *
- * ``` - * - * When the `ngHide` expression evaluates to a truthy value then the `.ng-hide` CSS class is added to the class - * attribute on the element causing it to become hidden. When falsy, the `.ng-hide` CSS class is removed - * from the element causing the element not to appear hidden. - * - * ## Why is !important used? - * - * You may be wondering why !important is used for the `.ng-hide` CSS class. This is because the `.ng-hide` selector - * can be easily overridden by heavier selectors. For example, something as simple - * as changing the display style on a HTML list item would make hidden elements appear visible. - * This also becomes a bigger issue when dealing with CSS frameworks. - * - * By using !important, the show and hide behavior will work as expected despite any clash between CSS selector - * specificity (when !important isn't used with any conflicting styles). If a developer chooses to override the - * styling to change how to hide an element then it is just a matter of using !important in their own CSS code. - * - * ### Overriding `.ng-hide` - * - * By default, the `.ng-hide` class will style the element with `display: none!important`. If you wish to change - * the hide behavior with ngShow/ngHide then this can be achieved by restating the styles for the `.ng-hide` - * class in CSS: - * - * ```css - * .ng-hide { - * /* this is just another form of hiding an element */ - * display: block!important; - * position: absolute; - * top: -9999px; - * left: -9999px; - * } - * ``` - * - * By default you don't need to override in CSS anything and the animations will work around the display style. - * - * ## A note about animations with `ngHide` - * - * Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression - * is true and false. This system works like the animation system present with ngClass, except that the `.ng-hide` - * CSS class is added and removed for you instead of your own CSS class. - * - * ```css - * // - * //a working example can be found at the bottom of this page - * // - * .my-element.ng-hide-add, .my-element.ng-hide-remove { - * transition: 0.5s linear all; - * } - * - * .my-element.ng-hide-add { ... } - * .my-element.ng-hide-add.ng-hide-add-active { ... } - * .my-element.ng-hide-remove { ... } - * .my-element.ng-hide-remove.ng-hide-remove-active { ... } - * ``` - * - * Keep in mind that, as of AngularJS version 1.3, there is no need to change the display - * property to block during animation states--ngAnimate will handle the style toggling automatically for you. - * - * @animations - * | Animation | Occurs | - * |----------------------------------|-------------------------------------| - * | {@link $animate#addClass addClass} `.ng-hide` | after the `ngHide` expression evaluates to a truthy value and just before the contents are set to hidden | - * | {@link $animate#removeClass removeClass} `.ng-hide` | after the `ngHide` expression evaluates to a non truthy value and just before contents are set to visible | - * - * - * @element ANY - * @param {expression} ngHide If the {@link guide/expression expression} is truthy then - * the element is shown or hidden respectively. - * - * @example - - - Click me:
-
- Show: -
- I show up when your checkbox is checked. -
-
-
- Hide: -
- I hide when your checkbox is checked. -
-
- - - @import url(../../components/bootstrap-3.1.1/css/bootstrap.css); - - - .animate-hide { - transition: all linear 0.5s; - line-height: 20px; - opacity: 1; - padding: 10px; - border: 1px solid black; - background: white; - } - - .animate-hide.ng-hide { - line-height: 0; - opacity: 0; - padding: 0 10px; - } - - .check-element { - padding: 10px; - border: 1px solid black; - background: white; - } - - - var thumbsUp = element(by.css('span.glyphicon-thumbs-up')); - var thumbsDown = element(by.css('span.glyphicon-thumbs-down')); - - it('should check ng-show / ng-hide', function() { - expect(thumbsUp.isDisplayed()).toBeFalsy(); - expect(thumbsDown.isDisplayed()).toBeTruthy(); - - element(by.model('checked')).click(); - - expect(thumbsUp.isDisplayed()).toBeTruthy(); - expect(thumbsDown.isDisplayed()).toBeFalsy(); - }); - - - */ -var ngHideDirective = ['$animate', function($animate) { - return { - restrict: 'A', - multiElement: true, - link: function(scope, element, attr) { - scope.$watch(attr.ngHide, function ngHideWatchAction(value) { - // The comment inside of the ngShowDirective explains why we add and - // remove a temporary class for the show/hide animation - $animate[value ? 'addClass' : 'removeClass'](element,NG_HIDE_CLASS, { - tempClasses: NG_HIDE_IN_PROGRESS_CLASS - }); - }); - } - }; -}]; - -/** - * @ngdoc directive - * @name ngStyle - * @restrict AC - * - * @description - * The `ngStyle` directive allows you to set CSS style on an HTML element conditionally. - * - * @knownIssue - * You should not use {@link guide/interpolation interpolation} in the value of the `style` - * attribute, when using the `ngStyle` directive on the same element. - * See {@link guide/interpolation#known-issues here} for more info. - * - * @element ANY - * @param {expression} ngStyle - * - * {@link guide/expression Expression} which evals to an - * object whose keys are CSS style names and values are corresponding values for those CSS - * keys. - * - * Since some CSS style names are not valid keys for an object, they must be quoted. - * See the 'background-color' style in the example below. - * - * @example - - - - - -
- Sample Text - 
myStyle={{myStyle}}
- - - span { - color: black; - } - - - var colorSpan = element(by.css('span')); - - it('should check ng-style', function() { - expect(colorSpan.getCssValue('color')).toBe('rgba(0, 0, 0, 1)'); - element(by.css('input[value=\'set color\']')).click(); - expect(colorSpan.getCssValue('color')).toBe('rgba(255, 0, 0, 1)'); - element(by.css('input[value=clear]')).click(); - expect(colorSpan.getCssValue('color')).toBe('rgba(0, 0, 0, 1)'); - }); - - - */ -var ngStyleDirective = ngDirective(function(scope, element, attr) { - scope.$watch(attr.ngStyle, function ngStyleWatchAction(newStyles, oldStyles) { - if (oldStyles && (newStyles !== oldStyles)) { - forEach(oldStyles, function(val, style) { element.css(style, '');}); - } - if (newStyles) element.css(newStyles); - }, true); -}); - -/** - * @ngdoc directive - * @name ngSwitch - * @restrict EA - * - * @description - * The `ngSwitch` directive is used to conditionally swap DOM structure on your template based on a scope expression. - * Elements within `ngSwitch` but without `ngSwitchWhen` or `ngSwitchDefault` directives will be preserved at the location - * as specified in the template. - * - * The directive itself works similar to ngInclude, however, instead of downloading template code (or loading it - * from the template cache), `ngSwitch` simply chooses one of the nested elements and makes it visible based on which element - * matches the value obtained from the evaluated expression. In other words, you define a container element - * (where you place the directive), place an expression on the **`on="..."` attribute** - * (or the **`ng-switch="..."` attribute**), define any inner elements inside of the directive and place - * a when attribute per element. The when attribute is used to inform ngSwitch which element to display when the on - * expression is evaluated. If a matching expression is not found via a when attribute then an element with the default - * attribute is displayed. - * - *
- * Be aware that the attribute values to match against cannot be expressions. They are interpreted - * as literal string values to match against. - * For example, **`ng-switch-when="someVal"`** will match against the string `"someVal"` not against the - * value of the expression `$scope.someVal`. - *
- - * @animations - * | Animation | Occurs | - * |----------------------------------|-------------------------------------| - * | {@link ng.$animate#enter enter} | after the ngSwitch contents change and the matched child element is placed inside the container | - * | {@link ng.$animate#leave leave} | after the ngSwitch contents change and just before the former contents are removed from the DOM | - * - * @usage - * - * ``` - * - * ... - * ... - * ... - * - * ``` - * - * - * @scope - * @priority 1200 - * @param {*} ngSwitch|on expression to match against ng-switch-when. - * On child elements add: - * - * * `ngSwitchWhen`: the case statement to match against. If match then this - * case will be displayed. If the same match appears multiple times, all the - * elements will be displayed. It is possible to associate multiple values to - * the same `ngSwitchWhen` by defining the optional attribute - * `ngSwitchWhenSeparator`. The separator will be used to split the value of - * the `ngSwitchWhen` attribute into multiple tokens, and the element will show - * if any of the `ngSwitch` evaluates to any of these tokens. - * * `ngSwitchDefault`: the default case when no other case match. If there - * are multiple default cases, all of them will be displayed when no other - * case match. - * - * - * @example - - -
- - selection={{selection}} -
-
-
Settings Div
-
Home Span
-
default
-
-
- - - angular.module('switchExample', ['ngAnimate']) - .controller('ExampleController', ['$scope', function($scope) { - $scope.items = ['settings', 'home', 'options', 'other']; - $scope.selection = $scope.items[0]; - }]); - - - .animate-switch-container { - position:relative; - background:white; - border:1px solid black; - height:40px; - overflow:hidden; - } - - .animate-switch { - padding:10px; - } - - .animate-switch.ng-animate { - transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s; - - position:absolute; - top:0; - left:0; - right:0; - bottom:0; - } - - .animate-switch.ng-leave.ng-leave-active, - .animate-switch.ng-enter { - top:-50px; - } - .animate-switch.ng-leave, - .animate-switch.ng-enter.ng-enter-active { - top:0; - } - - - var switchElem = element(by.css('[ng-switch]')); - var select = element(by.model('selection')); - - it('should start in settings', function() { - expect(switchElem.getText()).toMatch(/Settings Div/); - }); - it('should change to home', function() { - select.all(by.css('option')).get(1).click(); - expect(switchElem.getText()).toMatch(/Home Span/); - }); - it('should change to settings via "options"', function() { - select.all(by.css('option')).get(2).click(); - expect(switchElem.getText()).toMatch(/Settings Div/); - }); - it('should select default', function() { - select.all(by.css('option')).get(3).click(); - expect(switchElem.getText()).toMatch(/default/); - }); - - - */ -var ngSwitchDirective = ['$animate', '$compile', function($animate, $compile) { - return { - require: 'ngSwitch', - - // asks for $scope to fool the BC controller module - controller: ['$scope', function NgSwitchController() { - this.cases = {}; - }], - link: function(scope, element, attr, ngSwitchController) { - var watchExpr = attr.ngSwitch || attr.on, - selectedTranscludes = [], - selectedElements = [], - previousLeaveAnimations = [], - selectedScopes = []; - - var spliceFactory = function(array, index) { - return function(response) { - if (response !== false) array.splice(index, 1); - }; - }; - - scope.$watch(watchExpr, function ngSwitchWatchAction(value) { - var i, ii; - - // Start with the last, in case the array is modified during the loop - while (previousLeaveAnimations.length) { - $animate.cancel(previousLeaveAnimations.pop()); - } - - for (i = 0, ii = selectedScopes.length; i < ii; ++i) { - var selected = getBlockNodes(selectedElements[i].clone); - selectedScopes[i].$destroy(); - var runner = previousLeaveAnimations[i] = $animate.leave(selected); - runner.done(spliceFactory(previousLeaveAnimations, i)); - } - - selectedElements.length = 0; - selectedScopes.length = 0; - - if ((selectedTranscludes = ngSwitchController.cases['!' + value] || ngSwitchController.cases['?'])) { - forEach(selectedTranscludes, function(selectedTransclude) { - selectedTransclude.transclude(function(caseElement, selectedScope) { - selectedScopes.push(selectedScope); - var anchor = selectedTransclude.element; - caseElement[caseElement.length++] = $compile.$$createComment('end ngSwitchWhen'); - var block = { clone: caseElement }; - - selectedElements.push(block); - $animate.enter(caseElement, anchor.parent(), anchor); - }); - }); - } - }); - } - }; -}]; - -var ngSwitchWhenDirective = ngDirective({ - transclude: 'element', - priority: 1200, - require: '^ngSwitch', - multiElement: true, - link: function(scope, element, attrs, ctrl, $transclude) { - - var cases = attrs.ngSwitchWhen.split(attrs.ngSwitchWhenSeparator).sort().filter( - // Filter duplicate cases - function(element, index, array) { return array[index - 1] !== element; } - ); - - forEach(cases, function(whenCase) { - ctrl.cases['!' + whenCase] = (ctrl.cases['!' + whenCase] || []); - ctrl.cases['!' + whenCase].push({ transclude: $transclude, element: element }); - }); - } -}); - -var ngSwitchDefaultDirective = ngDirective({ - transclude: 'element', - priority: 1200, - require: '^ngSwitch', - multiElement: true, - link: function(scope, element, attr, ctrl, $transclude) { - ctrl.cases['?'] = (ctrl.cases['?'] || []); - ctrl.cases['?'].push({ transclude: $transclude, element: element }); - } -}); - -/** - * @ngdoc directive - * @name ngTransclude - * @restrict EAC - * - * @description - * Directive that marks the insertion point for the transcluded DOM of the nearest parent directive that uses transclusion. - * - * You can specify that you want to insert a named transclusion slot, instead of the default slot, by providing the slot name - * as the value of the `ng-transclude` or `ng-transclude-slot` attribute. - * - * If the transcluded content is not empty (i.e. contains one or more DOM nodes, including whitespace text nodes), any existing - * content of this element will be removed before the transcluded content is inserted. - * If the transcluded content is empty (or only whitespace), the existing content is left intact. This lets you provide fallback - * content in the case that no transcluded content is provided. - * - * @element ANY - * - * @param {string} ngTransclude|ngTranscludeSlot the name of the slot to insert at this point. If this is not provided, is empty - * or its value is the same as the name of the attribute then the default slot is used. - * - * @example - * ### Basic transclusion - * This example demonstrates basic transclusion of content into a component directive. - * - * - * - *
- *
- *
- * {{text}} - *
- * - * - * it('should have transcluded', function() { - * var titleElement = element(by.model('title')); - * titleElement.clear(); - * titleElement.sendKeys('TITLE'); - * var textElement = element(by.model('text')); - * textElement.clear(); - * textElement.sendKeys('TEXT'); - * expect(element(by.binding('title')).getText()).toEqual('TITLE'); - * expect(element(by.binding('text')).getText()).toEqual('TEXT'); - * }); - * - * - * - * @example - * ### Transclude fallback content - * This example shows how to use `NgTransclude` with fallback content, that - * is displayed if no transcluded content is provided. - * - * - * - * - * - * - * - * - * Button2 - * - * - * - * it('should have different transclude element content', function() { - * expect(element(by.id('fallback')).getText()).toBe('Button1'); - * expect(element(by.id('modified')).getText()).toBe('Button2'); - * }); - * - * - * - * @example - * ### Multi-slot transclusion - * This example demonstrates using multi-slot transclusion in a component directive. - * - * - * - *
- *
- *
- * - * {{title}} - *

{{text}}

 - * - *
- * - * - * angular.module('multiSlotTranscludeExample', []) - * .directive('pane', function() { - * return { - * restrict: 'E', - * transclude: { - * 'title': '?paneTitle', - * 'body': 'paneBody', - * 'footer': '?paneFooter' - * }, - * template: '
' + - * '
Fallback Title
' + - * '
' + - * '
Fallback Footer
' + - * '
' - * }; - * }) - * .controller('ExampleController', ['$scope', function($scope) { - * $scope.title = 'Lorem Ipsum'; - * $scope.link = 'https://google.com'; - * $scope.text = 'Neque porro quisquam est qui dolorem ipsum quia dolor...'; - * }]); - * - * - * it('should have transcluded the title and the body', function() { - * var titleElement = element(by.model('title')); - * titleElement.clear(); - * titleElement.sendKeys('TITLE'); - * var textElement = element(by.model('text')); - * textElement.clear(); - * textElement.sendKeys('TEXT'); - * expect(element(by.css('.title')).getText()).toEqual('TITLE'); - * expect(element(by.binding('text')).getText()).toEqual('TEXT'); - * expect(element(by.css('.footer')).getText()).toEqual('Fallback Footer'); - * }); - * - * - */ -var ngTranscludeMinErr = minErr('ngTransclude'); -var ngTranscludeDirective = ['$compile', function($compile) { - return { - restrict: 'EAC', - terminal: true, - compile: function ngTranscludeCompile(tElement) { - - // Remove and cache any original content to act as a fallback - var fallbackLinkFn = $compile(tElement.contents()); - tElement.empty(); - - return function ngTranscludePostLink($scope, $element, $attrs, controller, $transclude) { - - if (!$transclude) { - throw ngTranscludeMinErr('orphan', - 'Illegal use of ngTransclude directive in the template! ' + - 'No parent directive that requires a transclusion found. ' + - 'Element: {0}', - startingTag($element)); - } - - - // If the attribute is of the form: `ng-transclude="ng-transclude"` then treat it like the default - if ($attrs.ngTransclude === $attrs.$attr.ngTransclude) { - $attrs.ngTransclude = ''; - } - var slotName = $attrs.ngTransclude || $attrs.ngTranscludeSlot; - - // If the slot is required and no transclusion content is provided then this call will throw an error - $transclude(ngTranscludeCloneAttachFn, null, slotName); - - // If the slot is optional and no transclusion content is provided then use the fallback content - if (slotName && !$transclude.isSlotFilled(slotName)) { - useFallbackContent(); - } - - function ngTranscludeCloneAttachFn(clone, transcludedScope) { - if (clone.length && notWhitespace(clone)) { - $element.append(clone); - } else { - useFallbackContent(); - // There is nothing linked against the transcluded scope since no content was available, - // so it should be safe to clean up the generated scope. - transcludedScope.$destroy(); - } - } - - function useFallbackContent() { - // Since this is the fallback content rather than the transcluded content, - // we link against the scope of this directive rather than the transcluded scope - fallbackLinkFn($scope, function(clone) { - $element.append(clone); - }); - } - - function notWhitespace(nodes) { - for (var i = 0, ii = nodes.length; i < ii; i++) { - var node = nodes[i]; - if (node.nodeType !== NODE_TYPE_TEXT || node.nodeValue.trim()) { - return true; - } - } - } - }; - } - }; -}]; - -/** - * @ngdoc directive - * @name script - * @restrict E - * - * @description - * Load the content of a ` - - Load inlined template -
- - - it('should load template defined inside script tag', function() { - element(by.css('#tpl-link')).click(); - expect(element(by.css('#tpl-content')).getText()).toMatch(/Content of the template/); - }); - - - */ -var scriptDirective = ['$templateCache', function($templateCache) { - return { - restrict: 'E', - terminal: true, - compile: function(element, attr) { - if (attr.type === 'text/ng-template') { - var templateUrl = attr.id, - text = element[0].text; - - $templateCache.put(templateUrl, text); - } - } - }; -}]; - -/* exported selectDirective, optionDirective */ - -var noopNgModelController = { $setViewValue: noop, $render: noop }; - -/** - * @ngdoc type - * @name select.SelectController - * @description - * The controller for the ` and IE barfs otherwise. - self.unknownOption = jqLite(window.document.createElement('option')); - - // The empty option is an option with the value '' that te application developer can - // provide inside the select. When the model changes to a value that doesn't match an option, - // it is selected - so if an empty option is provided, no unknown option is generated. - // However, the empty option is not removed when the model matches an option. It is always selectable - // and indicates that a "null" selection has been made. - self.hasEmptyOption = false; - self.emptyOption = undefined; - - self.renderUnknownOption = function(val) { - var unknownVal = self.generateUnknownOptionValue(val); - self.unknownOption.val(unknownVal); - $element.prepend(self.unknownOption); - setOptionAsSelected(self.unknownOption); - $element.val(unknownVal); - }; - - self.updateUnknownOption = function(val) { - var unknownVal = self.generateUnknownOptionValue(val); - self.unknownOption.val(unknownVal); - setOptionAsSelected(self.unknownOption); - $element.val(unknownVal); - }; - - self.generateUnknownOptionValue = function(val) { - return '? ' + hashKey(val) + ' ?'; - }; - - self.removeUnknownOption = function() { - if (self.unknownOption.parent()) self.unknownOption.remove(); - }; - - self.selectEmptyOption = function() { - if (self.emptyOption) { - $element.val(''); - setOptionAsSelected(self.emptyOption); - } - }; - - self.unselectEmptyOption = function() { - if (self.hasEmptyOption) { - self.emptyOption.removeAttr('selected'); - } - }; - - $scope.$on('$destroy', function() { - // disable unknown option so that we don't do work when the whole select is being destroyed - self.renderUnknownOption = noop; - }); - - // Read the value of the select control, the implementation of this changes depending - // upon whether the select can have multiple values and whether ngOptions is at work. - self.readValue = function readSingleValue() { - var val = $element.val(); - // ngValue added option values are stored in the selectValueMap, normal interpolations are not - var realVal = val in self.selectValueMap ? self.selectValueMap[val] : val; - - if (self.hasOption(realVal)) { - return realVal; - } - - return null; - }; - - - // Write the value to the select control, the implementation of this changes depending - // upon whether the select can have multiple values and whether ngOptions is at work. - self.writeValue = function writeSingleValue(value) { - // Make sure to remove the selected attribute from the previously selected option - // Otherwise, screen readers might get confused - var currentlySelectedOption = $element[0].options[$element[0].selectedIndex]; - if (currentlySelectedOption) currentlySelectedOption.removeAttribute('selected'); - - if (self.hasOption(value)) { - self.removeUnknownOption(); - - var hashedVal = hashKey(value); - $element.val(hashedVal in self.selectValueMap ? hashedVal : value); - - // Set selected attribute and property on selected option for screen readers - var selectedOption = $element[0].options[$element[0].selectedIndex]; - setOptionAsSelected(jqLite(selectedOption)); - } else { - if (value == null && self.emptyOption) { - self.removeUnknownOption(); - self.selectEmptyOption(); - } else if (self.unknownOption.parent().length) { - self.updateUnknownOption(value); - } else { - self.renderUnknownOption(value); - } - } - }; - - - // Tell the select control that an option, with the given value, has been added - self.addOption = function(value, element) { - // Skip comment nodes, as they only pollute the `optionsMap` - if (element[0].nodeType === NODE_TYPE_COMMENT) return; - - assertNotHasOwnProperty(value, '"option value"'); - if (value === '') { - self.hasEmptyOption = true; - self.emptyOption = element; - } - var count = optionsMap.get(value) || 0; - optionsMap.put(value, count + 1); - // Only render at the end of a digest. This improves render performance when many options - // are added during a digest and ensures all relevant options are correctly marked as selected - scheduleRender(); - }; - - // Tell the select control that an option, with the given value, has been removed - self.removeOption = function(value) { - var count = optionsMap.get(value); - if (count) { - if (count === 1) { - optionsMap.remove(value); - if (value === '') { - self.hasEmptyOption = false; - self.emptyOption = undefined; - } - } else { - optionsMap.put(value, count - 1); - } - } - }; - - // Check whether the select control has an option matching the given value - self.hasOption = function(value) { - return !!optionsMap.get(value); - }; - - - var renderScheduled = false; - function scheduleRender() { - if (renderScheduled) return; - renderScheduled = true; - $scope.$$postDigest(function() { - renderScheduled = false; - self.ngModelCtrl.$render(); - }); - } - - var updateScheduled = false; - function scheduleViewValueUpdate(renderAfter) { - if (updateScheduled) return; - - updateScheduled = true; - - $scope.$$postDigest(function() { - if ($scope.$$destroyed) return; - - updateScheduled = false; - self.ngModelCtrl.$setViewValue(self.readValue()); - if (renderAfter) self.ngModelCtrl.$render(); - }); - } - - - self.registerOption = function(optionScope, optionElement, optionAttrs, interpolateValueFn, interpolateTextFn) { - - if (optionAttrs.$attr.ngValue) { - // The value attribute is set by ngValue - var oldVal, hashedVal = NaN; - optionAttrs.$observe('value', function valueAttributeObserveAction(newVal) { - - var removal; - var previouslySelected = optionElement.prop('selected'); - - if (isDefined(hashedVal)) { - self.removeOption(oldVal); - delete self.selectValueMap[hashedVal]; - removal = true; - } - - hashedVal = hashKey(newVal); - oldVal = newVal; - self.selectValueMap[hashedVal] = newVal; - self.addOption(newVal, optionElement); - // Set the attribute directly instead of using optionAttrs.$set - this stops the observer - // from firing a second time. Other $observers on value will also get the result of the - // ngValue expression, not the hashed value - optionElement.attr('value', hashedVal); - - if (removal && previouslySelected) { - scheduleViewValueUpdate(); - } - - }); - } else if (interpolateValueFn) { - // The value attribute is interpolated - optionAttrs.$observe('value', function valueAttributeObserveAction(newVal) { - // This method is overwritten in ngOptions and has side-effects! - self.readValue(); - - var removal; - var previouslySelected = optionElement.prop('selected'); - - if (isDefined(oldVal)) { - self.removeOption(oldVal); - removal = true; - } - oldVal = newVal; - self.addOption(newVal, optionElement); - - if (removal && previouslySelected) { - scheduleViewValueUpdate(); - } - }); - } else if (interpolateTextFn) { - // The text content is interpolated - optionScope.$watch(interpolateTextFn, function interpolateWatchAction(newVal, oldVal) { - optionAttrs.$set('value', newVal); - var previouslySelected = optionElement.prop('selected'); - if (oldVal !== newVal) { - self.removeOption(oldVal); - } - self.addOption(newVal, optionElement); - - if (oldVal && previouslySelected) { - scheduleViewValueUpdate(); - } - }); - } else { - // The value attribute is static - self.addOption(optionAttrs.value, optionElement); - } - - - optionAttrs.$observe('disabled', function(newVal) { - - // Since model updates will also select disabled options (like ngOptions), - // we only have to handle options becoming disabled, not enabled - - if (newVal === 'true' || newVal && optionElement.prop('selected')) { - if (self.multiple) { - scheduleViewValueUpdate(true); - } else { - self.ngModelCtrl.$setViewValue(null); - self.ngModelCtrl.$render(); - } - } - }); - - optionElement.on('$destroy', function() { - var currentValue = self.readValue(); - var removeValue = optionAttrs.value; - - self.removeOption(removeValue); - self.ngModelCtrl.$render(); - - if (self.multiple && currentValue && currentValue.indexOf(removeValue) !== -1 || - currentValue === removeValue - ) { - // When multiple (selected) options are destroyed at the same time, we don't want - // to run a model update for each of them. Instead, run a single update in the $$postDigest - scheduleViewValueUpdate(true); - } - }); - }; - - function setOptionAsSelected(optionEl) { - optionEl.prop('selected', true); // needed for IE - optionEl.attr('selected', true); - } -}]; - -/** - * @ngdoc directive - * @name select - * @restrict E - * - * @description - * HTML `select` element with angular data-binding. - * - * The `select` directive is used together with {@link ngModel `ngModel`} to provide data-binding - * between the scope and the `` menu is selected, the value of the selected option will be bound - * to the model identified by the `ngModel` directive. With static or repeated options, this is - * the content of the `value` attribute or the textContent of the `