Merge pull request #15 from HubSpot/experiment-class-naming

Experiment class naming

Author: gusvargas

README.md

@@ -11,14 +11,14 @@ npm install react-experiments
 
 # Usage
 
-react-experiments was built to work with [PlanOut.js](https://www.github.com/HubSpot/PlanOut.js) and most of its constructs are inspired by the structure of PlanOut.js. This library will work out of the box if you pass it an instantiated PlanOut Namespace or Experiment class, but if you want to use your own methods of assigning experiment parameters and logging exposure then you can extend the base [experiment class](https://github.com/HubSpot/react-experiments/blob/master/src/experimentClass.js) and pass that as the experiment class prop.
+react-experiments was built to work with [PlanOut.js](https://www.github.com/HubSpot/PlanOut.js) and most of its constructs are inspired by the structure of PlanOut.js. This library will work out of the box if you pass it an instantiated PlanOut Namespace or Experiment class, but if you want to use your own methods of assigning experiment parameters and logging exposure then you can extend the base [experiment class](https://github.com/HubSpot/react-experiments/blob/master/src/Experiment.js) and pass that as the experiment class prop.
 
 
 ## Implementing a simple experiment
 
 This library serves as a way to declaratively implement UI experiments that are defined via PlanOut. The standard usage of this library is as follows:
 
-1) Define experiment via PlanOut script / API. The PlanOut parameters that you set should map to the props on which you want to run an experiment. Let's use the [sample PlanOut.js experiment](https://github.com/HubSpot/PlanOut.js/blob/master/examples/sample_planout_es5.js#L41) as an example, which is effectively: 
+1) Define experiment via PlanOut script / API. The PlanOut parameters that you set should map to the props on which you want to run an experiment. Let's use the [sample PlanOut.js experiment](https://github.com/HubSpot/PlanOut.js/blob/master/examples/sample_planout_es5.js#L41) as an example, which is effectively:
 
 ```
 signupText = uniformChoice(choices=['Signup', 'Join now'])
@@ -69,7 +69,7 @@ let Parent = React.createClass({
 
 The implementation of all the components provided by this library are wrappers around a base ```Parametrize``` component. The ```Parametrize``` component allows for parametrizing a given component with experiment parameters. The following are the props that the ```Parametrize``` component takes:
 
-**experiment**: This is an instance of a PlanOut.js experiment / namespace class or the base experimentClass. [REQUIRED]
+**experiment**: This is an instance of a PlanOut.js experiment/namespace class or the base Experiment class. [REQUIRED]
 
 
 **params**: This is the list of experiment parameters that you want to use to parametrize the component. They should correspond to the parameter names defined in your PlanOut script / experiment definition. [REQUIRED]
@@ -78,7 +78,7 @@ The implementation of all the components provided by this library are wrappers a
 
 ### Higher-order Parametrization Components
 
-There are two primary higher-order components to use for parametrization. 
+There are two primary higher-order components to use for parametrization.
 
 **parametrize**: The ```parametrize``` function takes an instantiated experiment class, either an experiment name or a list of params, and a React component. It takes the given component and sets the deterministically and randomly assigned experiment parameters of the experiment class as props.
 
@@ -152,7 +152,7 @@ The ABTest component above branches off the value of ```this.props.experiment.ge
 
 The ABTest component takes the following as props:
 
-**experiment** - an instantiated PlanOut namespace or experiment class or a custom experimentClass. [REQUIRED]
+**experiment** - an instantiated PlanOut namespace/experiment class or a custom Experiment class. [REQUIRED]
 
 **on** - the parameter name to "branch" off [REQUIRED]
 

__tests__/testExperimentClass.js

@@ -4,7 +4,7 @@ import ReactExperiments from '../dist/react-experiments';
 let logs = [];
 const paramKey = 'foo';
 const paramVal = 'bar';
-class experiment extends ReactExperiments.experimentClass {
+class Experiment extends ReactExperiments.Experiment {
   get(param) {
     if (param === paramKey) {
       return paramVal;
@@ -24,7 +24,7 @@ class experiment extends ReactExperiments.experimentClass {
   }
 }
 
-const expClass = new experiment();
+const exp = new Experiment();
 const TestUtils = React.addons.TestUtils;
 describe('Test experiment', () => {
   beforeEach(() => {
@@ -47,7 +47,7 @@ describe('Test experiment', () => {
     });
 
     const parametrized = TestUtils.renderIntoDocument(
-      <ReactExperiments.Parametrize experiment={expClass} params={[paramKey]}>
+      <ReactExperiments.Parametrize experiment={exp} params={[paramKey]}>
         <Comp />
       </ReactExperiments.Parametrize>
     );
@@ -57,4 +57,4 @@ describe('Test experiment', () => {
     ).length).toBe(1);
     expect(logs.length).toEqual(1);
   });
-});
+});

build.sh

@@ -1,3 +1,2 @@
 node node_modules/webpack/bin/webpack --config build/webpack.config.js
 node node_modules/webpack/bin/webpack --config build/webpack.config.minified.js
-npm test

build/index.js

@@ -1,5 +1,5 @@
 import * as Variations from '../src/variationComponents';
-import experimentClass from '../src/experimentClass';
+import Experiment from '../src/Experiment';
 import ABTest from '../src/abtest';
 import Parametrize from '../src/parametrize';
 import withExperimentParams from '../src/withExperimentParams';
@@ -9,7 +9,7 @@ export default {
   ABTest: ABTest,
   When: Variations.When,
   Default: Variations.Default,
-  experimentClass: experimentClass,
+  Experiment: Experiment,
   Parametrize: Parametrize,
   withExperimentParams: withExperimentParams,
   parametrize: parametrize

dist/react-experiments.js

@@ -62,7 +62,7 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	var Variations = _interopRequireWildcard(__webpack_require__(1));
 
-	var experimentClass = _interopRequire(__webpack_require__(3));
+	var Experiment = _interopRequire(__webpack_require__(3));
 
 	var ABTest = _interopRequire(__webpack_require__(4));
 
@@ -76,7 +76,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	  ABTest: ABTest,
 	  When: Variations.When,
 	  Default: Variations.Default,
-	  experimentClass: experimentClass,
+	  Experiment: Experiment,
 	  Parametrize: Parametrize,
 	  withExperimentParams: withExperimentParams,
 	  parametrize: parametrize
@@ -190,12 +190,12 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	var _classCallCheck = function (instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } };
 
-	var experimentClass = (function () {
-	  function experimentClass() {
-	    _classCallCheck(this, experimentClass);
+	var Experiment = (function () {
+	  function Experiment() {
+	    _classCallCheck(this, Experiment);
 	  }
 
-	  _createClass(experimentClass, {
+	  _createClass(Experiment, {
 	    get: {
 	      value: function get(parameter) {
 	        throw "IMPLEMENT get";
@@ -223,12 +223,10 @@ return /******/ (function(modules) { // webpackBootstrap
 	    }
 	  });
 
-	  return experimentClass;
+	  return Experiment;
 	})();
 
-	;
-
-	module.exports = experimentClass;
+	module.exports = Experiment;
 
 /***/ },
 /* 4 */

dist/react-experiments.min.js

@@ -1,6 +1,6 @@
 {
   "name": "react-experiments",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "dependencies": {
     "react": "^0.13.3"
   },
@@ -48,8 +48,8 @@
     ]
   },
   "scripts": {
-    "test": "jest",
-    "build-and-test": "sh build.sh"
+    "test": "sh build.sh && jest",
+    "build": "sh build.sh"
   },
   "license": "MIT"
 }

package.json

@@ -1,4 +1,4 @@
-class experimentClass {
+export default class Experiment {
   get(parameter) {
     throw "IMPLEMENT get";
   }
@@ -19,5 +19,3 @@ class experimentClass {
     throw "IMPLEMENT shouldFetchExperimentParameter";
   }
 };
-
-export default experimentClass;