Merge pull request #2 from madmax983/Rewrite

Rewrite

Author: madmax983

.gitignore

@@ -10,3 +10,6 @@ build.properties
 #node_modules
 node_modules/
 jsforce.config.json
+
+#sfdx
+.sfdx/*

.travis.yml

@@ -0,0 +1,31 @@
+sudo: true
+dist: trusty
+cache: false
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+env:
+- URL=https://developer.salesforce.com/media/salesforce-cli/sfdx-linux-amd64.tar.xz
+before_install:
+- openssl aes-256-cbc -K $encrypted_bc21448d0b37_key -iv $encrypted_bc21448d0b37_iv
+  -in assets/server.key.enc -out assets/server.key -d
+- export SFDX_AUTOUPDATE_DISABLE=true
+- export SFDX_USE_GENERIC_UNIX_KEYCHAIN=true
+- export SFDX_DOMAIN_RETRY=300
+- wget -qO- $URL | tar xJf -
+- export DISPLAY=:99.0
+- sh -e /etc/init.d/xvfb start
+- ./sfdx/install
+- export PATH=./sfdx/$(pwd):$PATH
+- sfdx plugins:install salesforcedx@pre-release
+- sfdx force:auth:jwt:grant --clientid $CONSUMERKEY --jwtkeyfile assets/server.key
+  --username $USERNAME --setdefaultdevhubusername -a HubOrg
+script:
+- sfdx force:org:create -v HubOrg -s -f config/project-scratch-def.json -a ciorg
+- sfdx force:source:push -u ciorg
+- sfdx force:apex:test:run -u ciorg -c -r human
+- sfdx force:lightning:test:run -u ciorg
+- sfdx force:org:delete -u ciorg -p

README.md

@@ -1,89 +1,42 @@
+# Lightning-Redux [![Build Status](https://travis-ci.org/madmax983/lightning-redux.svg?branch=master)](https://travis-ci.org/madmax983/lightning-redux)
 
-# lightning-redux
-Lightning bindings for Redux
+## Usage
+The new version of Lightning-Redux simplifies the previous iteration down to a single Redux component. It serves as a wrapper around Redux itself, along with a few helper methods specific to Lightning.
 
-#Installation instructions:
+### Component Methods
+####
+##### createStore(name, reducer, initialState, middleware): create the Redux store.
 
-Simple Setup: Deploy the components to a Dev org.
+name: The name of the slice of state for the reducer creating the store.
 
-<a href="https://githubsfdeploy.herokuapp.com">
-    <img alt="Deploy to Salesforce" src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
-</a>
+reducer: Initial root reducer
 
-Advanced Setup:
+initialState: You can specify an initial shape to your store's shape.
 
-1. Clone repo
-2. Copy jsforce.config.editme.json and create jsforce.config.json.
-3. Enter target Salesforce org credentials.
-4. Install [npm](https://www.npmjs.com/) if you don't already have it.
-5. Run npm install on directory
+middleware: You can include redux middleware like redux-thunk here. Lightning-Redux automatically wraps this with Redux compose.
 
-#Gulp Targets
+##### dispatch(action): Works like you would expect. Dispatches the action to the Redux store. Fun fact: connect also sets a dispatch expando on the connected component for convenience.
 
-There are a few gulp targets available. Running gulp 'target' will deploy the components to the Salesforce Org in jsforce.config.json
+##### subscribe(listener): This shouldn't be needed to be implemented, but is provided in case you want to write a custom connect method. The listener callback will be called on store updates.
 
-deploy:base - the base Lightning-Redux bindings. These are all the component you need to use Redux in Lightning (plus redux.
-I am keeping a copy of Redux in the addons folder for convenience, but ideally you'll want to be installing
-it as a static resource with a fresh version). 
+##### replaceReducer(nextReducer): Wraps Redux's replaceReducer function. Replaces the reducer function in the redux store.
 
-deploy:addons - utility components and events to assist you in using Redux and Lightning Components together.
+##### registerReducer(name, reducer): Adds the specified reducer function to the redux store with the specificed name as it's slice of state.
 
-deploy:SimpleCounter - deploy the SimpleCounter example
+##### connect(mapStateToAttributes, target): mapStateToAttributes is a key pair object where the key is the attribute on the component you want set, and the value is either the value in the redux state graph, or a callback function. This function receives the component and state to compute the value. You can pass the component you want connected, but if it isn't populated, it will get populated by event.getSource(). It also sets a dispatch expando for convenience in the component's controller methods. 
 
-deploy:ComplexCounter - deploy the ComplexCounter example
+##### getState: Technically not a component method, this is a convenience expando that allows access to the Redux state.
 
-deploy:todo - deploy the todo example.
-        
-deploy:webpackTodo - deploy the webpackTodo example.
+## Installation
+Lightning-Redux Unmanaged Packaged (Redux Component, redux and redux-thunk static resource): https://login.salesforce.com/packaging/installPackage.apexp?p0=04t50000000M7PT
+Lightning-Redux-Examples (Counter and Todo Examples unmanaged package): https://login.salesforce.com/packaging/installPackage.apexp?p0=04t50000000M7Pi
 
-deploy:examples - deploy all of the examples
+Otherwise, you can use the SFDX CLI to convert the source and do a metadata deploy.
 
-deploy:kitchensink - DEPLOY ALL THE THINGS!
+## Resources
+Redux Documentation: http://redux.js.org/
+Awesome Redux: https://github.com/xgrommx/awesome-redux
+Lightning Components Developer Guide: https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/intro_framework.htm 
+Awesome Lightning: https://github.com/mailtoharshit/awesome-lighting
+Awesome Salesforce: https://github.com/mailtoharshit/awesome-salesforce
 
-After deploying, you will want to create a Preview style app to plunk the components in to see them. 
-Or take that Todo example, implement flexipage:availableForAllPageTypes", and plunk it down on your Lightning Experience homepage. 
-
-#Lightning-Redux Bindings
-You can just import Redux into a Lightning component and start using it right now as demonstrated in the SimpleCounter example. 
-However, a few binding components are provided here to assist you in architecting a Lightning-Redux app. 
-The base components are the Provider component, and a handful of events: reduxStoreChange, storeInitialized, and dispatchAction.
-
-In addition, there a number of utility components provided in the addons folder. These are demonstrated in the todoApp example, but as the webpackTodo example shows, they are not necessary.
-
-#Base Components
-##Provider
-The main interface between Redux and your Lightning Components. The Redux Store is kept inside a store aura:attribute with a type of "Object".
-You can either set the store directly via some bundled javascript file in the app level container, or pass the store in via the storeInitialized Event.
-Either way you will want to make sure to fire the storeInitialized event to bootstrap the provider.
-The provider emits reduxStoreChange events whenever there is a change in the store. Write handlers in your components to react to these changes, and make appropriate changes.
-It also handles a dispatchAction event. The payload that lightning event is an Action, and the handler for this event will dispatch the action on the store in the Provider.
-
-##storeIntitialized Event
-Has a store param for sending the store to be set in the Provider. 
-Also useful to write handlers on the other components when you want to have an action fire when the Provider first starts up(i.e. retrieving a list of SObjects from the DB)
-
-##reduxStoreChange Event
-This event is fired by the Provider whenever there is a change in the store. Write handlers on components that you want to react to changes in the store.
-
-##dispatchAction Event
-Lightning components can register and fire this event to send actions to be dispatched by the store in the Provider. 
-The use of this component can be eliminated by using the bindActionCreators utility method from Redux, as demonstrated in the webpackTodo example.
-
-#Addon Components
-##Reducer
-An abstract component that needs to be extended by a concrete component in order to function. Implement your reducers in these concrete components. 
-Setting the name attribute in your concrete implementation will determine the name of the key in Redux store graph.
-
-##RootReducer
-The RootReducer will take all the concrete Reducer components you write inside of it's {!v.body} and combine them with the combineReducers function from Redux.
-It will then emit a ReducersCombined event with this combined Reducer to be handled either by the top level app component, or a store component so that the store can be created.
-See the todoStore in the todoApp example for a demonstration.
-
-#Using a bundling library like Webpack or Browserify
-This is the best way to go, but can be a little daunting for beginners. 
-You can find a lot of great info at [Awesome Webpack](https://github.com/d3viant0ne/awesome-webpack), [Browserify Articles](http://browserify.org/articles.html)
-The webpackTodo example included in this repo should also give you a good idea of how to get started. The basic idea is to write all your javascript files the module import syntax you feel comfortable with.
-Then webpack or browserify will bundle this all together, and you can use this bundle directly in your Lightning Components. 
-The main thing is to expose the bundle as a library, and at the bare minimum export the store so that you can set it in the Provider component. 
-The webpackTodo example also shows how you can use bindActionCreators to export your actions for use in the Lightning Component controllers.
-One of the great benefits of using this model is that all your third-party dependencies are kept in one file (or multiple code-splitting files, if you're into that kind of thing), and you can use all the npm goodness like shrinkwrap, update, etc.