release/v1.0.2 (#129)

* Added contribution instructions

* remove production mode in the contributing guide.

* Remove squashing commits from contributing guide

* Add better examples for style guide.

* Add getting help section

* Change devsupport email to twitter

* Add link to contributing guide from the main readme

CONTRIBUTING.md

@@ -0,0 +1,198 @@
+# Contributing
+
+Thanks for checking out Clay. We accept pull requests from anybody, however we ask
+that you follow some conventions when contributing to Clay.
+
+We have set up a
+[piece-of-cake](https://github.com/pebble/clay/issues?q=is%3Aopen+is%3Aissue+label%3Apiece-of-cake)
+label in GitHub issues for bugs/features that are easy to implement. These issues are
+a great place to start for people that are new to the codebase.
+
+
+## Requirements
+
+ - [Node](https://nodejs.org) (4.0 and later)
+ - [Google Chrome](www.google.com/chrome) (To run tests)
+ - [Pebble SDK](https://developer.pebble.com/sdk/) (optional)
+
+
+## Getting Started
+
+### 1. Fork, then clone the repo:
+
+`$ git clone git@github.com:your-username/clay.git`
+
+### 2. Create a new branch with the following naming convention.
+
+`#<issue-id>/description-of-change`
+
+example:
+
+`#90/support-message-keys`
+
+If there is currently no GitHub issue open for your proposed contribution,
+then please make one. This allows us to assign milestones and triage priority.
+
+### 3. Install the project dependencies.
+
+`$ npm install`
+
+### 4. Develop your feature
+
+Commit as often as you like. Your branch will be squashed when the pull request is merged.
+
+### 5. Run the tests
+
+`$ npm run test`
+
+### 6. Run linting
+
+`$ npm run lint`
+
+### 7. Submit your pull request
+
+In the main comment of the pull request, you must state the GitHub issue that your PR
+resolves. You do this by using the syntax `Resolves #<issue-id>`. An example of this
+can be found [here](https://github.com/pebble/clay/pull/81)
+
+
+
+# Project Structure and Development
+
+
+## Important Files
+
+There are two main entry points for Clay - `index.js` and `src/scripts/config-page.js`.
+
+### index.js
+
+This is the main entry point for the code that will run in the Pebble app's `src/js/app.js`.
+It is responsible for serializing the provided config into a data URI that will be opened
+using `Pebble.openURL()`. It also persists data to `localStorage`.
+
+### src/scripts/config-page.js
+
+This is the main entry point for the code that runs on the generated config page,
+and is responsible for passing the injected config and other components to the
+`ClayConfig` class.
+
+
+## Building
+
+Use the following command to build Clay during development.
+
+`$ npm run dev`
+
+This command packages up `src/scripts/config-page.js` and `dev/dev.js` into the `tmp/` directory
+so `dev/dev.html` can include them as script tags. This will also watch for changes
+in the project.
+
+While developing components and other functionality for Clay, it is much easier to
+work with the files in the `dev/` directory than on a phone or emulator. Below is
+an explanation of the files and their purpose.
+
+| File | Purpose |
+|----------|-----|
+| `dev.html` | Open this page in a browser after running `$ npm run dev`. |
+| `dev.js` | Injects the components and dependencies into the window the same way `index.js` would. |
+| `config.js` | Clay config to use as a sandbox for testing components. |
+| `custom-fn.js` | Clay custom function to be injected by `dev.js`. |
+| `emulator.html` | Copy of the HTML page that is used to make the Clay compatible with the Pebble SDK emulator. |
+| `uri-test.html` | Used to stress test URI creation for older browser versions. |
+
+
+## Testing your change inside of a test project.
+
+Once your change is ready to be tested in the emulator or on the watch, follow these steps:
+
+1. From your Clay fork run `$ npm run pebble-build`. This builds Clay to work with the Pebble SDK
+2. From your test Pebble project, run `$ pebble package install /path/to/your/clay/fork`.
+  This will modify your `package.json` to point directly to your local copy of Clay.
+3. Run the usual`$ pebble build && pebble install --emulator basalt && pebble emu-app-config` to test your modifications
+4. If you make modifications to your fork of Clay, you must repeat the above steps.
+
+
+## Functionality
+
+Most of the magic happens in the `src/scripts/lib` directory. `config-page.js`
+initializes a new instance of `ClayConfig` and calls the injected custom function
+(`window.customFn`) with the `ClayConfig` as its context. This allows developers to
+add extra functionality to the config page, such as setting values of items dynamically
+or registering small custom components.
+
+Once the `ClayConfig` is initialized, we run the `.build()` method. This iterates over
+the config and injects each item into the page. Each item is an instance of `ClayItem`.
+It also indexes the items to later be retrieved with `.getAllItems()`,
+`.getItemByMessageKey()`, `.getItemById()`, `.getItemsByType()`.
+
+
+## Testing
+
+Clay enforces 100% test coverage. Chances are, that if you are submitting a pull request,
+there should be tests for the proposed code changes. Have a look at the other tests in
+the repository to see some examples of how you should be writing your tests.
+
+There are two commands to use while writing your tests.
+
+ - `$ npm run test` - Runs all tests once.
+ - `$ npm run test-debug` - Watches for file changes and re-runs all tests when it
+  detects a change. This also leaves an in instance of Google Chrome running.
+  If you click the "Debug" button in the top right of the page, a new tab will open.
+  You can then use the Google Chrome developer tools to debug your tests as they run.
+  Refreshing the page will re-run the tests.
+
+## Style Guide
+
+Our style guide is very similar to the
+[Airbnb style guide.](https://github.com/airbnb/javascript/tree/master/es5) with the
+following exceptions:
+
+ - When saving a reference to `this` use `self`.
+  ```javascript
+  // bad
+  function() {
+    var _this = this;
+    return function() {
+      console.log(_this);
+    };
+  }
+
+  // bad
+  function() {
+    var that = this;
+    return function() {
+      console.log(that);
+    };
+  }
+
+  // good
+  function() {
+    var self = this;
+    return function() {
+      console.log(self);
+    };
+  }
+  ```
+ - Don't double name your functions. It makes refactoring more difficult.
+
+ ```javascript
+ // bad
+ var log = function log(msg) {
+    console.log(msg);
+  };
+
+ // good
+ var log = function(msg) {
+    console.log(msg);
+  };
+ ```
+
+The style guide is enforced using ESLint. Run `$ npm run lint` to ensure you are
+adhering to the style guide.
+
+## Getting Help
+
+ - Chat to us in the `#clay` channel on slack. http://slack.pbldev.io/
+ - Visit the [Pebble Forums](https://forums.pebble.com/)
+ - Tweet at [@pebbledev](https://twitter.com/pebbledev)
+ - More options at https://developer.pebble.com/community/online/

README.md

@@ -1,10 +1,12 @@
 # Clay
 Clay is a JavaScript library that makes it easy to add offline configuration pages to your Pebble apps. All you need to get started is a couple lines of JavaScript and a JSON file; no servers or HTML required. 
 
-Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events traditionally implemented by developers to relay configuration settings to the watch side of the app. This step is not required when using Clay, since each config item is given the same `messageKey` as defined in `appinfo.json` (or PebbleKit JS Message Keys on CloudPebble), and is automatically transmitted once the configuration page is submitted by the user. Developers can override this behavior by [handling the events manually](#handling-the-showconfiguration-and-webviewclosed-events-manually).
+Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events traditionally implemented by developers to relay configuration settings to the watch side of the app. This step is not required when using Clay, since each config item is given the same `messageKey` as defined in `package.json` (or PebbleKit JS Message Keys on CloudPebble), and is automatically transmitted once the configuration page is submitted by the user. Developers can override this behavior by [handling the events manually](#handling-the-showconfiguration-and-webviewclosed-events-manually).
 
 Clay is distributed as a [Pebble package](https://developer.pebble.com/guides/pebble-packages/) so it is super easy to include in your project. If you are upgrading from v0.1.x of Clay you need to follow the [migration guide](#migrating-from-v01x-to-v1x) before you can get started.
 
+If you would like to contribute to Clay, check out the [contributing guide.](CONTRIBUTING.md)
+
 # Getting Started (SDK 3.13 or higher)
 
 1. Run `pebble package install pebble-clay` to install the package in your project
@@ -786,7 +788,7 @@ Clay will by default, automatically handle the 'showConfiguration' and 'webviewc
 Example:
 
 ```javascript
-var Clay = require('./clay');
+var Clay = require('pebble-clay');
 var clayConfig = require('./config');
 var clayConfigAplite = require('./config-aplite');
 var clay = new Clay(clayConfig, null, { autoHandleEvents: false });
@@ -829,7 +831,7 @@ If you are using [Pebble.js](https://developer.pebble.com/docs/pebblejs/) and wo
 
 ```javascript
 var Settings = require('settings');
-var Clay = require('./clay');
+var Clay = require('pebble-clay');
 var clayConfig = require('./config');
 var clay = new Clay(clayConfig, null, {autoHandleEvents: false});
 
@@ -899,7 +901,39 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
 | `Clay( [array] config, [function] customFn=null, [object] options={autoHandleEvents: true})` <br> `config` - an Array representing your config <br> `customFn` - function to be run in the context of the generated page <br> `options.autoHandleEvents` - set to `false` to prevent Clay from automatically handling the "showConfiguration" and "webviewclosed" events | `Clay` - a new instance of Clay. |
 | `.registerComponent( [ClayComponent] component )` <br> Registers a custom component. | `void`. |  
 | `.generateUrl()` | `string` - The URL to open with `Pebble.openURL()` to use the Clay-generated config page. |
-| `.getSettings( [object] response, [boolean] convert=true)` <br> `response` - the response object provided to the "webviewclosed" event <br> `convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `messageKey`, where the key is the `messageKey` and the value is the chosen value of that item.  This method will do some conversions depending on the type of the setting. Arrays containing strings will have zeros inserted before each item. eg `['one', 'two']` becomes `['one', 0, 'two', 0]`. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. Pass `false` as the second parameter to disable this behavior |
+| `.getSettings( [object] response, [boolean] convert=true)` <br> `response` - the response object provided to the "webviewclosed" event <br> `convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `messageKey`, where the key is the `messageKey` and the value is the chosen value of that item.  <br><br>This method will do some conversions depending on the type of the setting. Arrays will use message key array syntax to make the values of each item in the array available as individual message keys. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. If the value is a number or an array of numbers and the optional property: "precision" is the power of precision (value * 10 ^ precision) and then floored. Eg: `1.4567` with a precision set to `3` will become `1456`. Pass `false` as the second parameter to disable this behavior. See the example below for how this all works |
+
+#### `.getSettings()` Example 
+
+```javascript
+
+// webviewclosed response
+{
+  "favorite_food": {"value": [1, 0, 1]},
+  "cool_things_enabled": {"value": true},
+  "user_name": {"value": "Jane Doe"},
+  "date_of_birth[0]": {"value": 1989},
+  "date_of_birth[1]": {"value": 11},
+  "date_of_birth[2]": {"value": 28},
+  "rating": {"value": 3.5, "precision": 1},
+}
+
+// resulting converted values
+
+var messageKeys = require('message_keys');
+
+messageKeys.favorite_food + 0 = 1;
+messageKeys.favorite_food + 1 = 0;
+messageKeys.favorite_food + 2 = 1;
+messageKeys.cool_things_enabled = 1;
+messageKeys.user_name = 'Jane Doe';
+messageKeys.date_of_birth + 0 = 1989;
+messageKeys.date_of_birth + 1 = 11;
+messageKeys.date_of_birth + 2 = 28;
+messageKeys.rating = 35;
+
+
+``` 
 
 ---
 
@@ -919,7 +953,7 @@ Make sure to always wait for the config page to be built before manipulating ite
 ##### app.js
 
 ```javascript
-var Clay = require('./clay');
+var Clay = require('pebble-clay');
 var clayConfig = require('./config');
 var customClay = require('./custom-clay');
 var userData = {token: 'abc123'}
@@ -1056,7 +1090,7 @@ Components are simple objects with the following properties.
 Components must be registered before the config page is built. The easiest way to do this is in your `app.js` after you have initialized Clay:
 
 ```javascript
-var Clay = require('./clay');
+var Clay = require('pebble-clay');
 var clayConfig = require('./config.json');
 var clay = new Clay(clayConfig);
 
@@ -1093,56 +1127,6 @@ clay.registerComponent(require('./my-custom-component'));
  - `_.template()`
  - `_.isObject()`
 
-# Project Structure and Development 
-
-There are two main entry points for Clay - `index.js` and `src/scripts/config-page.js`. 
-
-#### index.js
-
-This is the main entry point for the code that will run in the Pebble app's `src/js/app.js`. It is responsible for serializing the provided config into a data URI that will be opened using `Pebble.openURL()`. It also persists data to `localStorage`. 
-
-#### src/scripts/config-page.js
-
-This is the main entry point for the code that runs on the generated config page, and is responsible for passing the injected config and other components to the `ClayConfig` class.
-
-
-### Building 
-
-There are two ways to build Clay, production mode and development mode. 
-
-#### Production Mode
-
-```
-$ npm run build
-```
-
-Packages up the entire Clay project into `dist/clay.js` to be required in the developer's `app.js`.
-
-#### Development Mode
-
-```
-$ npm run dev
-```
-
-Packages up `src/scripts/config-page.js` and `dev/dev.js` into the `tmp/` directory so `dev/dev.html` can include them as script tags. This will also watch for changes in the project. 
-
-While developing components and other functionality for Clay, it is much easier to work with the files in the `dev/` directory than on a phone or emulator. Below is an explanation of the files and their purpose.
-
-| File | Purpose |
-|----------|-----|
-| `dev.html` | Open this page in a browser after running `$ npm run dev`. |
-| `dev.js` | Injects the components and dependencies into the window the same way `index.js` would. |
-| `config.js` | Clay config to use as a sandbox for testing components. |
-| `custom-fn.js` | Clay custom function to be injected by `dev.js`. |
-| `emulator.html` | Copy of the HTML page that is used to make the Clay compatible with the Pebble SDK emulator. |
-| `uri-test.html` | Used to stress test URI creation for older browser versions. |
-
-## Functionality
-
-Most of the magic happens in the `src/scripts/lib` directory. `config-page.js` initializes a new instance of `ClayConfig` and calls the injected custom function (`window.customFn`) with the `ClayConfig` as its context. This allows developers to add extra functionality to the config page, such as setting values of items dynamically or registering small custom components. 
-
-Once the `ClayConfig` is initialized, we run the `.build()` method. This iterates over the config and injects each item into the page. Each item is an instance of `ClayItem`. It also indexes the items to later be retrieved with `.getAllItems()`, `.getItemByMessageKey()`, `.getItemById()`, `.getItemsByType()`.
-
 # Migrating from v0.1.x to v1.x
 
 There were some changes in the 3.13 SDK that required Clay to undergo some major changes. For the majority of developers a simple find and replace over your config will do the trick.
@@ -1176,6 +1160,74 @@ becomes:
 
 If you have a [custom function](#custom-function) and are using the `clayConfig.getItemByAppKey()` method you will need to change this to `clayConfig.getItemByMessageKey()`
 
+### clay.getSettings() will now by default, return an object where the keys are numbers.
+
+In the past, `clay.getSettings()` would return something that looked like:
+
+```javascript
+{
+  BACKGROUND_COLOR: 0,
+  NAME: 'Jane Doe',
+  ENABLE_TOOLS: 1
+}
+```
+
+It now uses the values provided in the `message_keys` module to construct this object.
+The new format looks something like:
+
+```javascript
+{
+  10000: 0,
+  10001: 'Jane Doe',
+  10002: 1
+}
+```
+
+If you wish to find out what keys are associated with what values, you must use the `message_keys` module.
+
+```javascript
+var messageKeys = require('message_keys');
+
+Pebble.addEventListener('webviewclosed', function(e) {
+  // Get the keys and values from each config item
+  var claySettings = clay.getSettings(e.response);
+
+  // In this example messageKeys.NAME is equal to 10001
+  console.log('Name is ' + claySettings[messageKeys.NAME]); // Logs: "Name is Jane Doe"
+});
+```
+
+**NOTE:** The above only applies to the default behavior of the method. If you pass
+`false` to the second argument, a standard object will be returned with the `messageKey`
+as the key.
+
+```javascript
+
+Pebble.addEventListener('webviewclosed', function(e) {
+
+  clay.getSettings(e.response);
+    /* returns:
+    {
+      10000: 0,
+      10001: 'Jane Doe',
+      10002: 1
+    }
+    */
+
+  clay.getSettings(e.response, false);
+    /* returns:
+    {
+      BACKGROUND_COLOR: {value: 0},
+      NAME: {value: 'Jane Doe'},
+      ENABLE_TOOLS: {value: true}
+    }
+
+    Notice that the value for ENABLE_TOOLS was not converted to a number from a boolean
+    */
+});
+
+```
+
 ### Checkbox groups now use arrays.
 
 In the previous version of Clay, checkbox groups would split the values of the items with zeros. This made for clumsy usage on the C side. Checkbox groups are now much simpler to use thanks to message keys. You will however need to update you config to the new format.

gulpfile.js

@@ -109,6 +109,7 @@ gulp.task('dev-js', ['js', 'sass'], function() {
     .transform('deamdify')
     .transform(sassify, sassifyOptions)
     .transform(autoprefixify, autoprefixerOptions)
+    .ignore('message_keys')
     .bundle()
     .pipe(source('dev.js'))
     .pipe(gulp.dest('./tmp/'));

index.js

@@ -210,9 +210,7 @@ Clay.prototype.getSettings = function(response, convert) {
 
   localStorage.setItem('clay-settings', JSON.stringify(settingsStorage));
 
-  return convert === false ?
-    settings :
-    Clay.prepareSettingsForAppMessage(settings, messageKeys);
+  return convert === false ? settings : Clay.prepareSettingsForAppMessage(settings);
 };
 
 /**
@@ -230,8 +228,8 @@ Clay.encodeDataUri = function(input, prefix) {
  *  - Strings will be returned without modification
  *  - Numbers will be returned without modification
  *  - Booleans will be converted to a 0 or 1
- *  - Arrays that contain strings will be split with a zero.
- *    eg: ['one', 'two'] becomes ['one', 0, 'two', 0]
+ *  - Arrays that contain strings will be returned without modification
+ *    eg: ['one', 'two'] becomes ['one', 'two']
  *  - Arrays that contain numbers will be returned without modification
  *    eg: [1, 2] becomes [1, 2]
  *  - Arrays that contain booleans will be converted to a 0 or 1
@@ -239,7 +237,7 @@ Clay.encodeDataUri = function(input, prefix) {
  *  - Arrays must be single dimensional
  *  - Objects that have a "value" property will apply the above rules to the type of
  *    value. If the value is a number or an array of numbers and the optional
- *    property: "precision" is provided, then the number will be multipled by 10 to
+ *    property: "precision" is provided, then the number will be multiplied by 10 to
  *    the power of precision (value * 10 ^ precision) and then floored.
  *    Eg: 1.4567 with a precision set to 3 will become 1456
  * @param {number|string|boolean|Array|Object} val

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pebble-clay",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Pebble Config Framework",
   "scripts": {
     "test-travis": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run --browsers chromeTravisCI && ./node_modules/.bin/eslint ./",
@@ -40,7 +40,10 @@
     ],
     "resources": {
       "media": []
-    }
+    },
+    "capabilities": [
+      "configurable"
+    ]
   },
   "homepage": "https://github.com/pebble/clay#readme",
   "devDependencies": {

src/scripts/components/color.js

@@ -116,12 +116,13 @@ module.exports = {
     function autoLayout() {
       if (!clay.meta.activeWatchInfo ||
           clay.meta.activeWatchInfo.firmware.major === 2 ||
-          clay.meta.activeWatchInfo.platform === 'aplite' &&
+          ['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
           !self.config.allowGray) {
         return standardLayouts.BLACK_WHITE;
       }
 
-      if (clay.meta.activeWatchInfo.platform === 'aplite' && self.config.allowGray) {
+      if (['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
+          self.config.allowGray) {
         return standardLayouts.GRAY;
       }
 

test/spec/components/color.js

@@ -434,6 +434,28 @@ describe('component - color', function() {
         suffix: ''
       }
     });
+    testAutoLayout('diorite', standardLayouts.BLACK_WHITE, false, '', {
+      platform: 'diorite',
+      model: 'qemu_platform_diorite',
+      language: 'en_US',
+      firmware: {
+        major: 4,
+        minor: 0,
+        patch: 0,
+        suffix: ''
+      }
+    });
+    testAutoLayout('diorite', standardLayouts.GRAY, true, '', {
+      platform: 'diorite',
+      model: 'qemu_platform_diorite',
+      language: 'en_US',
+      firmware: {
+        major: 4,
+        minor: 0,
+        patch: 0,
+        suffix: ''
+      }
+    });
 
     testCustomLayout();
     testCustomLayout('COLOR');