npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

angularjs-enzyme

v2.0.0

Published

[![npm](https://img.shields.io/npm/v/angularjs-enzyme.svg)](https://www.npmjs.com/package/angularjs-enzyme) [![GitHub release](https://img.shields.io/github/release/oliverviljamaa/angularjs-enzyme.svg)](https://github.com/oliverviljamaa/angularjs-enzyme/r

Downloads

90

Readme

:rotating_light: AngularJS Enzyme

npm GitHub release CircleCI npm

Unit testing utility for AngularJS (1.x), heavily inspired by the wonderful Enzyme API. :heart:
Therefore, it is well suited for organisations and individuals moving from AngularJS to React. It is test framework and runner agnostic, but the examples are written using Jest syntax.

An example showing the utility in use can be found here.

Available methods:
mount
mockComponent

Returned classes:
TestElementWrapper
mock

Usage

npm install angularjs-enzyme --save-dev

Module context

import { mount, mockComponent } from 'angularjs-enzyme';

Non-module context

  1. Include the script from node_modules/angularjs-enzyme/dist/angularjs-enzyme.js.
  2. Use the utility from the global context under the name angularjsEnzyme.

API

mount(tagName[, props]) => TestElementWrapper

Mounts the component with tagName (String) and optional props (Object) and returns a TestElementWrapper with numerous helper methods. The props are attached to the $ctrl available in the template scope. Only components with one-way bound props (<) can be mounted.

some-component.html

<h1>{{ $ctrl.title }}</h1>
<p>{{ $ctrl.text }}</p>
import 'angular';
import 'angular-mocks';
import { mount } from 'angularjs-enzyme';

describe('Component under test', () => {
  let component;
  beforeEach(() => {
    angular.mock.module('moduleOfComponentUnderTest');
    component = mount('some-component', { title: 'A title', text: 'Some text' });
  });
});

mockComponent(name) => mock

By default, AngularJS renders the whole component tree. This function mocks a child component with name (String) in the component under test and returns a mock. The child component won't be compiled and its controller won't be invoked, enabling testing the component under test in isolation. In addition, the returned mock has methods useful for testing.

import 'angular';
import 'angular-mocks';
import { mockComponent } from 'angularjs-enzyme';

describe('Component under test', () => {
  let childComponent;
  beforeEach(() => {
    angular.mock.module('moduleOfComponentUnderTest');
    childComponent = mockComponent('child-component'); // ⇦ after module, before inject
  });
});

TestElementWrapper API

.length => Number

The number of elements in the wrapper.

some-component.html

<ul>
  <li>1</li>
  <li>2</li>
  <li>3</li>
</ul>
it('has three list items', () => {
  expect(component.find('li').length).toBe(3);
});

.html() => String

Returns HTML of the wrapper. It should only be used for logging purposes, in tests other methods should be preferred.

some-component.html

<h1>Some title</h1>
it('renders title as html', () => {
  expect(component.html()).toBe('<h1>Some title</h1>');
});

.text() => String

some-component.html

<h1>Some title</h1>
<p>Some text</p>
it('has paragraph text', () => {
  expect(component.find('p').text()).toBe('Some text');
});

.hasClass(className) => Boolean

Returns whether the wrapper has a class with className (String) or not.

some-component.html

<button class="success">Pay</button>
it('has success class', () => {
  expect(component.find('button').hasClass('success')).toBe(true);
});

it('does not have error class', () => {
  expect(component.find('button').hasClass('error')).toBe(false);
});

.exists() => Boolean

Returns whether or not the wrapper contains any elements.

some-component.html

<button>Pay</button>
it('has button', () => {
  expect(component.find('button').exists()).toBe(true);
});

it('does not have link', () => {
  expect(component.find('a').exists()).toBe(false);
});

.find(selector) => TestElementWrapper

Returns a TestElementWrapper (for chaining) with every element matching the selector (String).

some-component.html

<div class="left">
  <a href="https://neopets.com">Wrong</a>
  <a href="https://transferwise.com">Wrong</a>
</div>
<div class="right">
  <a href="https://neopets.com">Wrong</a>
  <a href="https://transferwise.com">Correct</a>
</div>
it('has one transferwise link with corrext text on the right', () => {
  const link = component.find('.right a[href="https://transferwise.com"]');

  expect(link.length).toBe(1);
  expect(link.text()).toBe('Correct');
});

.first() => TestElementWrapper

Returns a TestElementWrapper (for chaining) for the first element.

some-component.html

<button class="btn btn-primary">Balance</button>
<button class="btn btn-primary">Bank transfer</button>
<button class="btn btn-primary">Card</button>
it('has balance as the first button', () => {
  const firstButton = component.find('button').first();
  expect(firstButton.text()).toBe('Balance');
});

.at(index) => TestElementWrapper

Returns a TestElementWrapper (for chaining) for element at index (Number).

some-component.html

<button class="btn btn-primary">Balance</button>
<button class="btn btn-primary">Bank transfer</button>
<button class="btn btn-primary">Card</button>
it('has card as third button', () => {
  const thirdButton = component.find('button').at(2);
  expect(thirdButton.text()).toBe('Card');
});

.map(fn) => Array<Any>

Maps the nodes in the wrapper to another array using fn (Function).

some-component.html

<ul>
  <li>One</li>
  <li>Two</li>
  <li>Three</li>
</ul>
it('has three list items with their number as a word', () => {
  const items = component.find('li');

  expect(items.map(item => item.text())).toEqual(['One', 'Two', 'Three']);
});

.props() => Object

Returns all wrapper props/attributes.

some-component.html

<a href="https://transferwise.com" target="_blank">Send money</a>
it('has transferwise link that opens in a new tab', () => {
  expect(component.find('a').props()).toEqual({
    href: 'https://transferwise.com',
    target: '_blank',
  });
});

.prop(key) => String

Returns wrapper prop/attribute value with provided key (String).

some-component.html

<a href="https://transferwise.com">Send money</a>
it('has transferwise link', () => {
  expect(component.find('a').prop('href')).toBe('https://transferwise.com');
});

.simulate(event[, data]) => Self

Calls an event handler on the wrapper for passed event with data (optional), updates the view, and returns wrapper for chaining.

NOTE: event should be written in camelCase and without the on present in the event handler name. Currently, change and click events are supported, with change requiring an event format.

some-component.html

<input ng-model="$ctrl.text" />
<p>{{ $ctrl.text }}</p>
<button ng-click="$ctrl.onClick($ctrl.text)">Click me</button>
let component;
let onClick;
beforeEach(() => {
  onClick = jest.fn();
  component = mount('some-component', { text: 'Original text', onClick });
});

it('calls click handler on button click', () => {
  const button = component.find('button');

  expect(onClick).not.toBeCalled();
  button.simulate('click');
  expect(onClick).toBeCalledWith('Original text');
});

it('changes text on input change', () => {
  const input = component.find('input');

  const text = () => component.find('p').text();

  expect(text()).toBe('Original text');
  input.simulate('change', { target: { value: 'New text' } });
  expect(text()).toBe('New text');
});

.setProps(props) => Self

Merges props (Object) with existing props and updates view to reflect them, returning itself for chaining.

some-component.html

<h1>{{ $ctrl.title }}</h1>
<p>{{ $ctrl.text }}</p>
it('changes title and text when props change', () => {
  const component = mount('some-component', {
    title: 'Original title',
    text: 'Original text',
  });

  const title = () => component.find('h1').text();
  const text = () => component.find('p').text();

  expect(title()).toBe('Original title');
  expect(text()).toBe('Original text');
  component.setProps({ title: 'New title', text: 'New text' });
  expect(title()).toBe('New title');
  expect(text()).toBe('New text');
});

mock API

.exists() => Boolean

Returns whether or not the mocked component exists in the rendered template.

some-component.html

<button ng-click="$ctrl.show = !$ctrl.show">
  Show child
</button>
<child-component ng-if="$ctrl.show"></child-component>
let component;
beforeEach(() => {
  component = mount('some-component');
});

it('allows toggling child component', () => {
  const button = component.find('button');

  expect(childComponent.exists()).toBe(false);
  button.simulate('click');
  expect(childComponent.exists()).toBe(true);
  button.simulate('click');
  expect(childComponent.exists()).toBe(false);
});

.props() => Object

Returns all mocked component props.

some-component.html

<div>Something else</div>
<child-component
  some-prop="'A string'",
  some-other-prop="12345"
></child-component>
let component;
beforeEach(() => {
  component = mount('some-component');
});

it('passes props to child component', () => {
  expect(childComponent.props()).toEqual({
    someProp: 'A string',
    someOtherProp: 12345,
  });
});

.prop(key) => Any

Returns mocked component prop value with the provided key (String).

some-component.html

<div>Something else</div>
<child-component some-prop="'A string'"></child-component>
let component;
beforeEach(() => {
  component = mount('some-component');
});

it('passes some prop to child component', () => {
  expect(childComponent.prop('someProp')).toBe('A string');
});

.simulate(event[, data]) => Self

Calls an event handler on the mocked component for passed event with data (optional), updates the view, and returns mocked component for chaining.

NOTE: event should be written in camelCase and without the on present in the event handler name. So, to call onSomePropChange, .simulate('somePropChange') should be used.

some-component.html

<div>Something else</div>
<child-component
  on-some-prop-change="onSomePropChange"
></child-component>
it('calls parent component with data when child component is called', () => {
  const onSomePropChange = jest.fn();
  mount('some-component', { onSomePropChange });

  expect(onSomePropChange).not.toBeCalled();
  childComponent.simulate('somePropChange', 'New value');
  expect(onSomePropChange).toBeCalledWith('New value');
});

Contributing

  1. Run tests with npm run test:watch. npm test will check for package and changelog version match, ESLint and Prettier format in addition.
  2. Bump version number in package.json according to semver and add an item that a release will be based on to CHANGELOG.md.
  3. Submit your pull request from a feature branch and get code reviews.
  4. If the pull request is approved and the CircleCI build passes, you will be able to squash/rebase and merge.
  5. Code will automatically be released to GitHub and published to npm according to the version specified in the changelog and package.json.

Other

For features and bugs, feel free to add issues or contribute.