Merge pull request #13 from Jefreesujit/develop

Next Release v0.2.0

Author: dhanushuUzumaki

.babelrc

@@ -1,13 +1,10 @@
 {
-  "presets": ["es2015", "react"],
-  "plugins": [
-    "transform-decorators-legacy",
-    "transform-class-properties",
-    "transform-object-rest-spread"
-  ],
+  "presets": ["env", "react", "stage-2"],
   "env": {
+    "browser": true,
     "test": {
-      "plugins": ["istanbul"]
+      "presets": [["env"], "react"]
     }
-  }
-}
+  },
+  "plugins": ["transform-object-rest-spread"]
+}

.eslintrc

@@ -0,0 +1,54 @@
+{
+  "parser": "babel-eslint",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "plugins": ["prettier"],
+  "extends": [
+    "airbnb",
+    "prettier",
+    "plugin:prettier/recommended"
+  ],
+  "rules": {
+      "prefer-destructuring": 0,
+      "no-console": 0,
+      "react/no-unused-prop-types": 0,
+      "react/prefer-stateless-function": 0,
+      "react/jsx-filename-extension": 0,
+      "react/forbid-prop-types": 0,
+      "react/require-default-props": 0,
+      "comma-dangle": 0,
+      "space-before-function-paren": [0, {
+          "anonymous": "always",
+          "named": "always",
+          "asyncArrow": "always"
+      }],
+      "no-underscore-dangle": 0,
+      "import/prefer-default-export": 0,
+      "object-curly-newline": 0,
+      "jsx-a11y/anchor-is-valid": 0,
+      "arrow-body-style": 0,
+      "react/no-array-index-key": 0,
+      "consistent-return": 0,
+      "no-return-assign": 0,
+      "jsx-a11y/no-autofocus": 0,
+      "jsx-a11y/tabindex-no-positive": 0,
+      "prettier/prettier": "error",
+      "import/no-extraneous-dependencies": 0,
+      "react/jsx-one-expression-per-line": 0,
+      "react/prop-types": 0,
+      "jsx-a11y/label-has-for": [ 2, {
+            "components": [ "Label" ],
+            "required": {
+                "every": [ "id" ]
+            },
+            "allowChildren": false
+        }]
+  },
+  "env": {
+    "browser": true,
+    "node": true
+  }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,28 +8,17 @@ about: Create a report to help us improve
 A clear and concise description of what the bug is.
 
 **To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+Steps to reproduce the behavior
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+**Desktop (if applicable please complete the following information):**
+ - OS: [e.g. OSX]
+ - Version [e.g. High Sierra 10.13.5]
 
 **Additional context**
 Add any other context about the problem here.

.gitignore

@@ -1,3 +1,8 @@
 .DS_Store
 node_modules
-example/index.build.js
+index.build.js
+es
+umd
+/*.js
+!setupTests.js
+!*.config.js

.npmignore

@@ -0,0 +1 @@
+example

.travis.yml

@@ -1,6 +1,24 @@
 language: node_js
 node_js:
-  - "8"
-  - "6"
-script:
-  - npm run build
+- '8'
+jobs:
+  include:
+  - stage: lint
+    script:
+    - npm run lint
+  - stage: build and test
+    before_script:
+    - npm install -g babel-cli rollup
+    script:
+    - npm run build
+    - npm run test
+deploy:
+  provider: npm
+  email: jefree.sujit@gmail.com
+  api_key:
+    secure: BrBdcCxXWJwvcHyfXPp5d8aIfj4IgZoej61w0Jh42XJuku52ODggJyEzZWX8WWf97oefopw0wW5AuxBAOOqiamk3p8ASMbNV5yK8y0E4RPS8ECouUJ4ZXNBiO243P32mizQBExa1SEarrH2o7keBSgWLF0Rd9dvHJPhuq9YhE9YziZZB/FrXNbblM5lYbShRKZ7kajADW9EWYO3DHai179B8QWBdQEU+y8Y0d6Knmg7szJorH0HYX9Wj3kN3+hAXnTk+21cDVtmLsGjl/6W1RQ9AVsJEBk/RfLgpAqGhFIUdX/1Ff0sKPp39LWvtJBiDF9src/M/Y2HSPPhgcO6ACPBb5ko5tZTXfaDvhwvOUm/qBnK4bl/9A4/SMfpBWyxfnKeRcW+iEK8qurxGVcPj86BN8dwLBrdff9v+RI+/lQvq+oEPbkXLdtsYRhRHtv7k4i2lPKjz/+ms98jVk/XJOe83yB78Eky5JBhmT+0tNpVV/IdAu/XgptCudIPfwfnzMPWc+p7FpQ+Q5ssMvY3tILdg83vBgA4qA7AMOJ7+uTSR+14L7J8FlUeTLYOfzjq3sxvC5T2+6QXG9XpjxT+1gJveze5gYu9QBc3MmKWNykyR61maxIQEm1Va71tVtCQrqID9RXq7KxBLIA7Z1LHfuR9ON86dqNs3Xnn5pJTXGgs=
+  on:
+    tags: true
+    repo: Jefreesujit/react-context-redux
+    branch: master
+  skip_cleanup: true

BUILDING.md

@@ -0,0 +1,25 @@
+# Building and Running Locally
+
+react-context-redux is very simple to setup and start contributing.
+
+Dependencies:
+
+* Node.js
+* babel-cli: ^6.26.3 (Global)
+* rollup: ^0.62.0 (Global)
+
+Once you have the above installed, you are good to go.
+
+## Installing the required packages.
+
+Make sure to run `npm i` on the root folder of react-context-redux repo.
+
+## Building the package.
+
+Once you have made the changes and ready to build and test, run `npm run build` to build the production artifacts.
+
+While developing you can use `npm run watch`. This will watch the `src` folder and build things whenever a file is saved.
+
+## Building the example.
+
+Example can be built by running `npm run build:example`

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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, gender identity and expression, level of experience, 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 e.jefree110@gmail.com or a.p.dhanushu@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing to react-context-redux
+
+Contributions to react-context-redux include code, documentation, answering user questions and advocating for all types of users.
+
+The react-context-redux project welcomes all contributions from anyone willing to work in
+good faith with other contributors and the community. No contribution is too
+small and all contributions are valued.
+
+This guide explains the process for contributing to the react-context-redux project's core
+`Jefreesujit/react-context-redux` GitHub Repository and describes what to expect at each step.
+
+## [Code of Conduct](./CODE_OF_CONDUCT.md)
+
+The react-context-redux project has a
+[Code of Conduct](https://github.com/Jefreesujit/react-context-redux/blob/master/CODE_OF_CONDUCT.md)
+that *all* contributors are expected to follow. This code describes the
+*minimum* behavior expectations for all contributors.
+
+See [details on our policy on Code of Conduct](https://github.com/Jefreesujit/react-context-redux/blob/master/CODE_OF_CONDUCT.md).
+
+## [Issues](./doc/guides/contributing/issues.md)
+
+Issues in react-context-redux are the primary means by which bug reports and
+general discussions are made.
+
+* [How to Contribute in Issues](./doc/guides/contributing/issues.md#how-to-contribute-in-issues)
+* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
+* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
+* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report)
+* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-feature-request)
+* [Triaging a Bug Report](./doc/guides/contributing/issues.md#triaging-a-bug-report)
+* [Resolving a Bug Report](./doc/guides/contributing/issues.md#resolving-a-bug-report)
+
+## [Pull Requests](./doc/guides/contributing/pull-requests.md)
+
+Pull Requests are the way concrete changes are made to the code, documentation,
+dependencies, and tools contained in the `nodejs/node` repository.
+
+* [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies)
+* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment)
+* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes)
+* [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests)
+
+<a id="developers-certificate-of-origin"></a>
+## Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+* (a) The contribution was created in whole or in part by me and I
+  have the right to submit it under the open source license
+  indicated in the file; or
+
+* (b) The contribution is based upon previous work that, to the best
+  of my knowledge, is covered under an appropriate open source
+  license and I have the right under that license to submit that
+  work with modifications, whether created in whole or in part
+  by me, under the same open source license (unless I am
+  permitted to submit under a different license), as indicated
+  in the file; or
+
+* (c) The contribution was provided directly to me by some other
+  person who certified (a), (b) or (c) and I have not modified
+  it.
+
+* (d) I understand and agree that this project and the contribution
+  are public and that a record of the contribution (including all
+  personal information I submit with it, including my sign-off) is
+  maintained indefinitely and may be redistributed consistent with
+  this project or the open source license(s) involved.

DOCUMENTATION.md

@@ -0,0 +1,92 @@
+## Modules
+
+<dl>
+<dt><a href="#module_connect">connect</a></dt>
+<dd></dd>
+<dt><a href="#module_createStore">createStore</a> ⇒ <code>Node</code> | <code>function</code></dt>
+<dd><p>Creates an global store.</p>
+</dd>
+<dt><a href="#module_provider">provider</a></dt>
+<dd></dd>
+</dl>
+
+<a name="module_connect"></a>
+
+## connect
+<a name="module_connect..actionCallback"></a>
+
+### connect~actionCallback(actionCallback)
+To dispatch values to global store.
+
+**Kind**: inner method of [<code>connect</code>](#module_connect)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| actionCallback | <code>function</code> | A function that receives dispatch function as a param |
+
+<a name="module_createStore"></a>
+
+## createStore ⇒ <code>Node</code> \| <code>function</code>
+Creates an global store.
+
+**Returns**: <code>Node</code> - - Returns a wrapper provider component<code>function</code> - - A "connect" function to connect a component with global state  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| defaultState | <code>Object</code> | The default state of the application need to create the store |
+
+
+* [createStore](#module_createStore) ⇒ <code>Node</code> \| <code>function</code>
+    * [~dispatch(options)](#module_createStore..dispatch)
+    * [~connect(select, component)](#module_createStore..connect) ⇒ <code>Node</code>
+
+<a name="module_createStore..dispatch"></a>
+
+### createStore~dispatch(options)
+To update values in global store.
+
+**Kind**: inner method of [<code>createStore</code>](#module_createStore)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>Object</code> | A object with the details to update values in global store |
+| options.key | <code>string</code> | KeyPath to which the value has to be assigned, separated by '.' |
+| options.payload | <code>Object</code> | Value to be set against the provided Keypath |
+
+<a name="module_createStore..connect"></a>
+
+### createStore~connect(select, component) ⇒ <code>Node</code>
+Connects the passed component with the global store.
+
+**Kind**: inner method of [<code>createStore</code>](#module_createStore)  
+**Returns**: <code>Node</code> - - A wrapper React element  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| select | <code>function</code> | To map global state to props, should return an JSON object |
+| component | <code>Node</code> | A React element, to which the props has to be passed |
+
+<a name="module_provider"></a>
+
+## provider
+
+* [provider](#module_provider)
+    * [~Provider](#module_provider..Provider)
+        * [new Provider()](#new_module_provider..Provider_new)
+
+<a name="module_provider..Provider"></a>
+
+### provider~Provider
+**Kind**: inner class of [<code>provider</code>](#module_provider)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| defaultState | <code>object</code> | The default state of the application need to create the store, if not passed as part of createStore |
+| children | <code>Node</code> | React element for which the store should be made available |
+
+<a name="new_module_provider..Provider_new"></a>
+
+#### new Provider()
+Provider Component.
+