react_on_rails 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b65b6529dca9ed1cf1b205cec960efe38885a17
-  data.tar.gz: e5d5bf65c4c63282de650747d26795f7517b4d3f
+  metadata.gz: ff569925f1a426faa8225029a9aafe82ecf5fa79
+  data.tar.gz: 4ce5a157fb81a422afa0f180d65fde5ec5a77e8f
 SHA512:
-  metadata.gz: 1f9cbb2bada17276368ebae143d7a16c72c7f5fcda30f06bcbaf42049f4bf427af6e3d98f55ed651a212dfd9591f40ac37bbed52adbd2e36b869ca2f86962806
-  data.tar.gz: e440d984febebef5f5685f447788e83caf01cd1be2486c091a5a6ae5db6fc723a67ff40347098ae95ae5ac94f97790612107e39d35e018fa3bb8afa308af1dc2
+  metadata.gz: 001b480c4688afd9509688efce9ae15843a1fff806c743eed38d3a83d8fec795b57ee65f97da805275d1a929be75cff1fbbd67caa31d5a130ae3c9d063da7a0e
+  data.tar.gz: c923e3c422e59c109e04f77ccbd27f63473c0927d80258b5b7883eb5fb648a174ec5997f01b166b6a508e8e2d7a2f40bc21edac04bf19e1143027a6c51ad1881

data/CHANGELOG.md

@@ -4,10 +4,18 @@ All notable changes to this project will be documented in this file. Items under
 Contributors: please follow the recommendations outlined at [keepachangelog.com](http://keepachangelog.com/). Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the `Unreleased` link to compare to the latest release version.
 
 ## [Unreleased]
+
+## [2.2.0] - 2016-01-29
+##### Added
+- New JavaScript API for debugging TurboLinks issues. Be sure to see [turbolinks docs](docs/additional_reading/turbolinks.md). `ReactOnRails.setOptions({ traceTurbolinks: true });`. Removed the file `debug_turbolinks` added in 2.1.1. See [#243](https://github.com/shakacode/react_on_rails/pull/243).
+
+## [2.1.1] - 2016-01-28
+
 ##### Fixed
 - Fixed regression where apps that were not using Turbolinks would not render components on page load.
 
 ##### Added
+- `ReactOnRails.render` returns a virtualDomElement Reference to your React component's backing instance. See [#234](https://github.com/shakacode/react_on_rails/pull/234).
 - `debug_turbolinks` helper for debugging turbolinks issues. See [turbolinks](docs/additional_reading/turbolinks.md).
 - Enhanced regression testing for non-turbolinks apps. Runs all tests for dummy app with turbolinks both disabled and enabled.
 
@@ -72,7 +80,7 @@ Best done with Object destructing:
 - JS Linter uses ShakaCode JavaScript style: https://github.com/shakacode/style-guide-javascript
 - Generators account these differences.
 
-##### Migration Steps
+##### Migration Steps v1 to v2
 [Example of upgrading](https://github.com/shakacode/react-webpack-rails-tutorial/commit/5b1b8698e8daf0f0b94e987740bc85ee237ef608)
 
 1. Update the `react_on_rails` gem.
@@ -82,7 +90,8 @@ Best done with Object destructing:
 5. Update your index.jade to use the new API `ReactOnRails.render("MyApp", !{props}, 'app');`
 6. Update your webpack files per the example commit. Remove globally exposing React and ReactDom, as well as their inclusion in the `entry` section. These are automatically included now.
 7. Run `cd client && npm i --save react-on-rails` to get react-on-rails into your `client/package.json`.
-8. You should also update any other dependencies if possible to match up with the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/).
+8. You should also update any other dependencies if possible to match up with the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). This includes updating to Babel 6.
+9. If you want to stick with Babel 5 for a bit, see [Issue #238](https://github.com/shakacode/react_on_rails/issues/238).
 
 ---
 
@@ -119,7 +128,9 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/v2.1.0...HEAD
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/2.2.0...HEAD
+[2.2.0]: https://github.com/shakacode/react_on_rails/compare/2.1.1...2.2.0
+[2.1.1]: https://github.com/shakacode/react_on_rails/compare/v2.1.0...2.1.1
 [2.1.0]: https://github.com/shakacode/react_on_rails/compare/v2.0.2...v2.1.0
 [2.0.2]: https://github.com/shakacode/react_on_rails/compare/v2.0.1...v2.0.2
 [2.0.1]: https://github.com/shakacode/react_on_rails/compare/v2.0.0...v2.0.1

data/README.md

@@ -2,9 +2,9 @@
 
 # NEWS
 
-* 2.1 has shipped on Tuesday, 2/26/2016. Please see the [Changelog](CHANGELOG.md) for details, and let us know if you see any issues! [Migration steps from 1.x](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#migration-steps).
+* 2.2 has shipped on Tuesday, 1/29/2016. Please see the [Changelog](CHANGELOG.md) for details, and let us know if you see any issues! [Migration steps from 1.x](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#migration-steps-v1-to-v2).
 * Highlights:
-  1. Fixed a **critical** problem with TurboLinks.
+  1. Fixed a **critical** problem with TurboLinks. Be sure to see [turbolinks docs](docs/additional_reading/turbolinks.md) for more information on how to debug TurboLinks issues.
   2. Provides a convenient helper to ensure that JavaScript assets are compiled before running tests.
 * React on Rails does not yet have *generator* support for building new apps that use CSS modules and hot reloading via the Rails server as is demonstrated in the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). *We do support this, but we don't generate the code.* If you did generate a fresh app from react_on_rails and want to move to CSS Modules, then see [PR 175: Babel 6 / CSS Modules / Rails hot reloading](https://github.com/shakacode/react-webpack-rails-tutorial/pull/175). Note, while there are probably fixes after this PR was accepted, this has the majority of the changes. See [the tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/#news) for more information. Ping us if you want to help!
 * [ShakaCode](http://www.shakacode.com) is doing Skype plus Slack/Github based coaching for "React on Rails". [Click here](http://www.shakacode.com/work/index.html) for more information.
@@ -378,6 +378,7 @@ Note: If you have components from react-rails you want to use, then you will nee
 
 ## Additional Reading
 + [The React on Rails Doctrine](http://www.shakacode.com/2016/01/26/the-react-on-rails-doctrine.html)
++ [Babel](docs/additional_reading/babel.md)
 + [Generated Client Code](docs/additional_reading/generated_client_code.md)
 + [Heroku Deployment](docs/additional_reading/heroku_deployment.md)
 + [Manual Installation](docs/additional_reading/manual_installation.md)

data/docs/additional_reading/babel.md

@@ -0,0 +1,3 @@
+# Babel
+
+As of React on Rails 2.0, we recommend Babel 6. If you want to stick with Babel 5 for a bit, see [Issue #238](https://github.com/shakacode/react_on_rails/issues/238).

data/docs/additional_reading/turbolinks.md

@@ -19,8 +19,39 @@ the JavaScript and stylesheets are cached by the browser, as they will still req
    ```javascript
    //= require turbolinks
    ```
+Note, in the future, we might change to installing this via npm.
 
 ## Troubleshooting
-To turn on tracing of Turbolinks events, require `debug_turbolinks` (provided by ReactOnRails) inside of `app/assets/javascripts/application.js` **at the beginning of the file**. This will print out events related to the initialization of the components created with the view helper `react_component`.
+To turn on tracing of Turbolinks events, put this in your registration file, where you register your components. 
+
+```js
+   ReactOnRails.setOptions({
+     traceTurbolinks: true,
+   });
+```
+
+Rather than setting the value to true, you could set it to TRACE_TURBOLINKS, and then you could place this in your `webpack.client.base.config.js`:
+
+Define this const at the top of the file:
+```js
+  const devBuild = process.env.NODE_ENV !== 'production';
+```
+
+Add this DefinePlugin option:
+```js
+  plugins: [
+   new webpack.DefinePlugin({
+     TRACE_TURBOLINKS: devBuild,
+   }),
+```
+
+At Webpack compile time, the value of devBuild is inserted into your file.
+
+Once you do that, you'll see messages prefixed with **TURBO:** like this in the browser console:
+
+```
+TURBO: WITH TURBOLINKS: document page:before-unload and page:change handlers installed. (program)
+TURBO: reactOnRailsPageLoaded
+```
 
 We've noticed that Turbolinks doesn't work if you use the ruby gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages instead. See the [tutorial app](https://github.com/shakacode/react-webpack-rails-tutorial) for how to accomplish this.

data/docs/contributing.md

@@ -41,13 +41,33 @@ npm i
 npm run build
 ```
 
-Use either npm-link (described below), or use a relative path in your `package.json`, like this:
-
-```js
-"react-on-rails": "../path-to-react-on-rails".
+Use a relative path in your `package.json`, like this:
+```sh
+cd client
+npm install --save "react-on-rails@../../react_on_rails"
 ```
 
-If you use a relative path, be sure to run `npm i` whenever you rebuild the node package.
+When you use a relative path, be sure to run the above `npm install` command whenever you change the node package for react-on-rails.
+
+Wihle we'd prefer to us `npm link`, we get errors. If you can figure out how to get `npm link react-on-rails` to work with this project, please file an issue or PR! This used to work with babel 5.
+
+This is the error:
+
+```
+16:34:11 rails-client-assets.1 | ERROR in /react_on_rails/node_package/lib/ReactOnRails.js
+16:34:11 rails-client-assets.1 | Module build failed: ReferenceError: Unknown plugin "react-transform" specified in "base" at 0, attempted to resolve relative to "/react_on_rails/node_package/lib"
+16:34:11 rails-client-assets.1 |     at /react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/file/options/option-manager.js:193:17
+16:34:11 rails-client-assets.1 |     at Array.map (native)
+16:34:11 rails-client-assets.1 |     at Function.normalisePlugins (/react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/file/options/option-manager.js:173:20)
+16:34:11 rails-client-assets.1 |     at OptionManager.mergeOptions (/react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/file/options/option-manager.js:271:36)
+16:34:11 rails-client-assets.1 |     at OptionManager.init (/react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/file/options/option-manager.js:416:10)
+16:34:11 rails-client-assets.1 |     at File.initOptions (/react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/file/index.js:191:75)
+16:34:11 rails-client-assets.1 |     at new File (/react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/file/index.js:122:22)
+16:34:11 rails-client-assets.1 |     at Pipeline.transform (/react-webpack-rails-tutorial/client/node_modules/babel-core/lib/transformation/pipeline.js:42:16)
+16:34:11 rails-client-assets.1 |     at transpile (/react-webpack-rails-tutorial/client/node_modules/babel-loader/index.js:14:22)
+16:34:11 rails-client-assets.1 |     at Object.module.exports (/react-webpack-rails-tutorial/client/node_modules/babel-loader/index.js:88:12)
+16:34:11 rails-client-assets.1 |  @ ./app/bundles/comments/startup/clientRegistration.jsx 15:20-45
+```
 
 # Development Setup for Gem and Node Package Contributors
 
@@ -164,6 +184,10 @@ All linting is performed from the docker container for CI. You will need docker
 Once you have docker and docker-compose running locally, run `docker-compose build lint`. This will build the `reactonrails_lint` docker image and docker-compose `lint` container. The initial build is slow, but after the install, startup is very quick.
 
 ### Linting Commands
+Run `rake lint`. 
+
+Alternately with Docker:
+
 Run `rake -D docker` to see all docker linting commands for rake. `rake docker:lint` will run all linters. For individual rake linting commands please refer to `rake -D docker` for the list.
 
 You can run specific linting for directories or files by using `docker-compose run lint rubocop (file path or directory)`, etc.

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "2.1.1".freeze
+  VERSION = "2.2.0".freeze
 end

data/lib/react_on_rails/version_checker.rb

@@ -61,7 +61,7 @@ module ReactOnRails
       end
 
       def relative_path?
-        raw.match(/\.\./).present?
+        raw.match(%r{(\.\.|\Afile:///)}).present?
       end
 
       def major

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -50,6 +50,7 @@
     "symlink-node-package": "node_package/scripts/symlink-node-package",
     "prepublish": "npm run build",
     "build": "node_package/scripts/build",
+    "build-watch": "$(npm bin)/babel --watch --out-dir node_package/lib node_package/src",
     "eslint": "eslint . --ext .jsx and .js",
     "jscs": "jscs . -e -v",
     "lint": "npm run eslint && npm run jscs",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -285,10 +285,10 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- app/assets/javascripts/debug_turbolinks.js
 - app/helpers/react_on_rails_helper.rb
 - docker-compose.yml
 - docs/LICENSE
+- docs/additional_reading/babel.md
 - docs/additional_reading/heroku_deployment.md
 - docs/additional_reading/manual_installation.md
 - docs/additional_reading/node_dependencies_and_npm.md

data/app/assets/javascripts/debug_turbolinks.js

@@ -1,4 +0,0 @@
-window.DEBUG_TURBOLINKS = true;
-console.log('window.DEBUG_TURBOLINKS = true;');
-console.log('To disable Turbolinks debugging, remove the debug_turbolinks require' +
-            ' from app/assets/javascripts/application.js');