Merge pull request #26 from naman03malhotra/dwl-count

[Patch] Add more badges in readme file, add code of conduct, trigger workflow for forked PRs [v1.3.6]

Author: naman03malhotra

.github/workflows/CI.yml

@@ -5,6 +5,10 @@ on:
     branches-ignore:
       - master
 
+  pull_request_target:
+    branches-ignore:
+      - master
+
 jobs:
   test:
     name: Test on node ${{ matrix.node }} and ${{ matrix.os }}
@@ -14,8 +18,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [10, 12]
-        os: [ubuntu-latest, macOS-latest]
+        node: [10, 12, 15]
+        os: [ubuntu-latest]
 
     steps:
       - uses: actions/checkout@v1

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at naman03malhotra@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -9,15 +9,16 @@ _**I wrote a [detailed blog post](https://dev.to/naman03malhotra/declaring-your-
 ### Install
 
 [![Build Status](https://github.com/naman03malhotra/match-rules/workflows/CI/badge.svg?branch=master)](https://github.com/naman03malhotra/match-rules/actions)
-
 [![Build Status](https://github.com/naman03malhotra/match-rules/workflows/CD/badge.svg?branch=master)](https://github.com/naman03malhotra/match-rules/actions)
-
 [![Coverage Status](https://coveralls.io/repos/github/naman03malhotra/match-rules/badge.svg?branch=master&kill_cache=1)](https://coveralls.io/github/naman03malhotra/match-rules?branch=master&kill_cache=1)
+[![npm](https://img.shields.io/npm/dm/match-rules)](https://www.npmjs.com/package/match-rules)
+![npm](https://img.shields.io/npm/dt/match-rules)
+![NPM](https://img.shields.io/npm/l/match-rules)
+[![npm](https://img.shields.io/npm/v/match-rules)](https://www.npmjs.com/package/match-rules)
+[![DeepScan grade](https://deepscan.io/api/teams/11791/projects/14725/branches/280135/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=11791&pid=14725&bid=280135)
 
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/match-rules?label=GZipped&style=for-the-badge)](https://bundlephobia.com/result?p=match-rules)
 
-<!-- [![npm](https://img.shields.io/npm/dm/match-rules)](https://www.npmjs.com/package/match-rules) -->
-
 Through Yarn
 `yarn add match-rules`
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "match-rules",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "A tiny (1kB GZipped) zero dependency JavaScript utility that lets you write your conditional business logic in a declarative way (React like).",
   "main": "lib/match_rules.js",
   "repository": {

tests/match_rules.spec.js

@@ -30,7 +30,9 @@ describe("Test matchRules", () => {
 
   const RULE_WITH_FUNCTION = {
     user_profile: {
-      age: (value) => value > 18 && value < 50,
+      age: (value, sourceObject) =>
+        (value > 18 && value < 50 && sourceObject.country === "USA") ||
+        sourceObject.show_ads === true,
     },
   };
 
@@ -67,6 +69,7 @@ describe("Test matchRules", () => {
       can_send: true,
       can_delete: false,
     },
+    country: "USA",
   };
 
   beforeEach(() => {
@@ -190,6 +193,17 @@ describe("Test matchRules", () => {
     expect(matchRules(mainSource, RULE_WITH_FUNCTION)).toBe(true);
   });
 
+  it("should execute the function with two parameters first being the key's value and second being the original source object", () => {
+    const spyFn = jest.spyOn(RULE_WITH_FUNCTION.user_profile, "age");
+
+    const result = matchRules(mainSource, RULE_WITH_FUNCTION);
+    expect(spyFn).toBeCalledTimes(1);
+    expect(spyFn).toBeCalledWith(mainSource.user_profile.age, mainSource);
+    expect(result).toBe(true);
+
+    spyFn.mockRestore();
+  });
+
   it("should do string matching when the rule has a string value", () => {
     expect(matchRules(mainSource, RULE_WITH_STRING)).toBe(true);
   });