Add toIncludeRepeated matcher

README.md

@@ -689,8 +689,6 @@ test('passes when value includes substring', () => {
 
 #### .toIncludeRepeated(substring, times)
 
-_Note: Currently unimplemented_
-
 Use `.toIncludeRepeated` when checking if a `String` includes the given `String` substring the correct number of times.
 
 ```js

src/matchers/index.js

@@ -40,6 +40,7 @@ import toBeNil from './toBeNil';
 import toSatisfyAll from './toSatisfyAll';
 import toBeEmpty from './toBeEmpty';
 import toBeSealed from './toBeSealed';
+import toIncludeRepeated from './toIncludeRepeated';
 
 export default [
   toBeEven,
@@ -83,5 +84,6 @@ export default [
   toSatisfyAll,
   toBeEmpty,
   toBeSealed,
-  toSatisfy
+  toSatisfy,
+  toIncludeRepeated
 ].reduce((acc, matcher) => ({ ...acc, ...matcher }), {});

src/matchers/toIncludeRepeated/__snapshots__/index.test.js.snap

@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`.not.toIncludeRepeated fails when given string includes given substring 1 time 1`] = `
+"<dim>expect(</><red>received</><dim>).not.toIncludeRepeated(</><green>expected</><dim>)</>
+
+Expected string to not include repeated 1 times:
+  <green>\\"ell\\"</>
+Received:
+  <red>\\"hello world\\"</>"
+`;
+
+exports[`.not.toIncludeRepeated fails when given string includes given substring to the given occurrences 1`] = `
+"<dim>expect(</><red>received</><dim>).not.toIncludeRepeated(</><green>expected</><dim>)</>
+
+Expected string to not include repeated 3 times:
+  <green>\\"l\\"</>
+Received:
+  <red>\\"hello world\\"</>"
+`;
+
+exports[`.toIncludeRepeated fails when given string does not have a given substring the correct number of times 1`] = `
+"<dim>expect(</><red>received</><dim>).toIncludeRepeated(</><green>expected</><dim>)</>
+
+Expected string to include repeated 2 times:
+  <green>\\"world\\"</>
+Received:
+  <red>\\"hello world\\"</>"
+`;
+
+exports[`.toIncludeRepeated fails when given string does not include given substring 1`] = `
+"<dim>expect(</><red>received</><dim>).toIncludeRepeated(</><green>expected</><dim>)</>
+
+Expected string to include repeated 1 times:
+  <green>\\"bob\\"</>
+Received:
+  <red>\\"hello world\\"</>"
+`;

src/matchers/toIncludeRepeated/index.js

@@ -0,0 +1,30 @@
+import { matcherHint, printExpected, printReceived } from 'jest-matcher-utils';
+
+import predicate from './predicate';
+
+const passMessage = (actual, expected, occurrences) => () =>
+  matcherHint('.not.toIncludeRepeated') +
+  '\n\n' +
+  `Expected string to not include repeated ${occurrences} times:\n` +
+  `  ${printExpected(expected)}\n` +
+  'Received:\n' +
+  `  ${printReceived(actual)}`;
+
+const failMessage = (actual, expected, occurrences) => () =>
+  matcherHint('.toIncludeRepeated') +
+  '\n\n' +
+  `Expected string to include repeated ${occurrences} times:\n` +
+  `  ${printExpected(expected)}\n` +
+  'Received:\n' +
+  `  ${printReceived(actual)}`;
+
+export default {
+  toIncludeRepeated: (actual, expected, occurrences) => {
+    const pass = predicate(actual, expected, occurrences);
+    if (pass) {
+      return { pass: true, message: passMessage(actual, expected, occurrences) };
+    }
+
+    return { pass: false, message: failMessage(actual, expected, occurrences) };
+  }
+};

src/matchers/toIncludeRepeated/index.test.js

@@ -0,0 +1,41 @@
+import matcher from './';
+
+expect.extend(matcher);
+
+const string = 'hello world';
+
+describe('.toIncludeRepeated', () => {
+  test('passes when a string includes a given substring 1 time', () => {
+    expect(string).toIncludeRepeated('ell', 1);
+  });
+
+  test('passes when a string includes a given substring 3 times', () => {
+    expect(string).toIncludeRepeated('l', 3);
+  });
+
+  test('fails when given string does not include given substring', () => {
+    expect(() => expect(string).toIncludeRepeated('bob', 1)).toThrowErrorMatchingSnapshot();
+  });
+
+  test('fails when given string does not have a given substring the correct number of times', () => {
+    expect(() => expect(string).toIncludeRepeated('world', 2)).toThrowErrorMatchingSnapshot();
+  });
+});
+
+describe('.not.toIncludeRepeated', () => {
+  test('fails when given string includes given substring 1 time', () => {
+    expect(() => expect(string).not.toIncludeRepeated('ell', 1)).toThrowErrorMatchingSnapshot();
+  });
+
+  test('fails when given string includes given substring to the given occurrences', () => {
+    expect(() => expect(string).not.toIncludeRepeated('l', 3)).toThrowErrorMatchingSnapshot();
+  });
+
+  test('passes when given string does not include given substring', () => {
+    expect(string).not.toIncludeRepeated('bob', 1);
+  });
+
+  test('passes when given string does not have a given substring the correct number of times', () => {
+    expect(string).not.toIncludeRepeated('world', 2);
+  });
+});

src/matchers/toIncludeRepeated/predicate.js

@@ -0,0 +1,2 @@
+export default (string, substring, occurrences) =>
+  (string.match(new RegExp(substring, 'g')) || []).length === occurrences;

src/matchers/toIncludeRepeated/predicate.test.js

@@ -0,0 +1,25 @@
+import predicate from './predicate';
+
+const string = 'hello world';
+const multi = `
+  hello world
+  hello world
+`;
+
+describe('Predicate > .toIncludeRepeated', () => {
+  test('passes when string contains substring', () => {
+    expect(predicate(string, 'l', 3)).toBe(true);
+  });
+
+  test('passes when given a multiline string includes given substring hello 2 times', () => {
+    expect(predicate(multi, 'hello', 2)).toBe(true);
+  });
+
+  test('fails when string does not contain substring', () => {
+    expect(predicate(string, 'bob', 1)).toBe(false);
+  });
+
+  test('fails when string does not contain substring for the given occurrences', () => {
+    expect(predicate(string, 'l', 10)).toBe(false);
+  });
+});