react_on_rails 6.8.0 → 6.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d813add5f006c6deca243a7504707a2cc4e6373c
-  data.tar.gz: 2d354c343883a102b500f6d7131e6d8b2d72b640
+  metadata.gz: dc8f8c909150f3c94e83be4c4bfd84e825719bd9
+  data.tar.gz: a781fe780fcbed2447441b0f897f6b8b7dd2a2f1
 SHA512:
-  metadata.gz: 2cdec4b31916d1eb5267f71bdd9597dadf898a905234ff6e93879c6760045b99ea4793baea90d01cb0b590f994f82c2fd0dc00bae462d79a7b421f5d4edbc378
-  data.tar.gz: 783214e29c1f16cc991a9d1e4e9f9a10ddeefa56a1818cb0568538a463d48615e31d46769e1f0d78a0d614dd28f392fe31e7ba2f7361511418e926c75b4734a6
+  metadata.gz: b350e72c6b4ab2ea3a634112ec02bbbf4f063301bc8e4ab10c0f7bbfeecf3f7a12f42722f5057c9b57c5e32b67ad1584674342448134b46be2b4e8f558f5a1e7
+  data.tar.gz: ad7c94f6049fbce20494dc0be0c0fbaf0cdbbc5bd441dae460df912117e7753ebea44a65ef2dddb402009e82f14e22879fcf25809ce561a7efadea4de5563312

data/.eslintignore

@@ -10,3 +10,4 @@ node_package/webpack.config.js
 **/generated/**
 **/app/assets/javascripts/application.js
 **/coverage/**
+**/cable.js

data/.travis.yml

@@ -5,7 +5,8 @@ language: ruby
 rvm:
   # Ruby 2.0.0 fails due to newer Nokogir
   # nokogiri-1.7.0.1 requires ruby version >= 2.1.0, which is incompatible with the current version, ruby 2.0.0p648
-  - 2.1.10
+  # Rails 5 requires 2.2
+  # - 2.1.10
   - 2.2.6
   - 2.3.1
 services:
@@ -25,7 +26,6 @@ env:
     - RAILS_ENV=test
     - DRIVER=selenium_chrome
     - CHROME_BIN=/usr/bin/google-chrome
-    - ENABLE_TURBOLINKS_5=TRUE
     - USE_COVERALLS=TRUE
 
 before_install:
@@ -36,11 +36,11 @@ before_install:
   - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16"
 
 install:
-  - nvm install node
+  - travis_retry nvm install node
   - node -v
-  - npm i -g yarn@0.20.3
-  - yarn
-  - bundle install
+  - travis_retry npm i -g yarn@0.20.3
+  - travis_retry yarn
+  - travis_retry bundle install
   - rake dummy_apps
   - rake examples
   - rake node_package

data/CHANGELOG.md

@@ -5,6 +5,11 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 
 ## [Unreleased]
 *Please add entries here for your pull requests.*
+
+## [6.8.1] - 2017-03-21
+### Fixed
+- Fixed error "The node you're attempting to unmount was rendered by another copy of React." [#706](https://github.com/shakacode/react_on_rails/issues/706) when navigating to cached page using Turbolinks  [#763](https://github.com/shakacode/react_on_rails/pull/763) by [szyablitsky](https://github.com/szyablitsky).
+
 ## [6.8.0] - 2017-03-06
 ## Added
 - Converted to Webpack v2 for generators, tests, and all example code. [#742](https://github.com/shakacode/react_on_rails/pull/742) by [justin808](https://github.com/justin808).
@@ -29,7 +34,7 @@ Commenting out this line addresses the issue:
 
 ```
 config.i18n_dir = Rails.root.join("client", "app", "libs", "i18n")
-``` 
+```
 
 ### Added
 - Allow using rake task to generate javascript locale files. The test helper automatically creates the localization files when needed. [#717](https://github.com/shakacode/react_on_rails/pull/717) by [JasonYCHuang](https://github.com/JasonYCHuang).
@@ -484,7 +489,8 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.8.0...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.8.1...master
+[6.8.1]: https://github.com/shakacode/react_on_rails/compare/6.8.0...6.8.1
 [6.8.0]: https://github.com/shakacode/react_on_rails/compare/6.7.2...6.8.0
 [6.7.2]: https://github.com/shakacode/react_on_rails/compare/6.7.1...6.7.2
 [6.7.1]: https://github.com/shakacode/react_on_rails/compare/6.7.0...6.7.1

data/CONTRIBUTING.md

@@ -44,7 +44,8 @@ When making doc changes, we want the change to work on both the gitbook and the
 ## To run tests:
 * After updating code via git, to prepare all examples and run all tests:
 
-```
+```sh
+cd react_on_rails/
 bundle && yarn && rake examples:prepare_all && rake node_package && rake
 ```
 
@@ -72,9 +73,17 @@ It's critical to configure your IDE/editor to ignore certain directories. Otherw
 * /spec/react_on_rails/dummy-for-generators
 
 # Configuring your test app to use your local fork
+You can test the `react-on-rails` gem using your own external test app or the gem's internal `spec/dummy` app. The `spec/dummy` app is an example of the various setup techniques you can use with the gem.
+```
+├── test
+|    └── client
+└── react_on_rails
+    └── spec
+        └── dummy
+```
 
-## Ruby Gem
-If you want to test the gem with an application before you release a new version of the gem, you can specify the path to your local version via your test app's Gemfile:
+## Testing the Ruby Gem
+If you want to test the ruby parts of the gem with an application before you release a new version of the gem, you can specify the path to your local version via your test app's Gemfile:
 
 ```ruby
 gem "react_on_rails", path: "../path-to-react-on-rails"
@@ -82,22 +91,31 @@ gem "react_on_rails", path: "../path-to-react-on-rails"
 
 Note that you will need to bundle install after making this change, but also that **you will need to restart your Rails application if you make any changes to the gem**.
 
-## NPM for react-on-rails
-First, be **sure** to build the NPM package
+## Testing the Node package for react-on-rails
+In addition to testing the Ruby parts out, you can also test the node package parts of the gem with an external application. First, be **sure** to build the NPM package:
 
 ```sh
+cd react_on_rails/
 yarn
 yarn run build
 ```
 
-Use a relative path in your `package.json`, like this:
+Install the local package by using a relative path in your test/client app's `package.json`, like this:
 ```sh
-cd client
-yarn add "react-on-rails@../../react_on_rails"
+cd test/client
+npm i --save 'react-on-rails@../path-to-react-on-rails'
 ```
+_Note: You must use npm here till yarn stops preferring cached packages over local. see [issue #2649](https://github.com/yarnpkg/yarn/issues/2649)_
 
 When you use a relative path, be sure to run the above `yarn` command whenever you change the node package for react-on-rails.
 
+#### Example: Testing NPM changes with the dummy app
+1. Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails/blob/master/node_package/src/clientStartup.js#L181) in `react_on_rails/node_package/src/clientStartup.js` to confirm we're getting an update to the node package.
+2. Run the install script `npm run install-react-on-rails` in `react_on_rails/spec/dummy` to copy over our changes to the dummy app. Alternatively, you can run `npm i --save 'file:../../../'` in `react_on_rails/spec/dummy/client`. Our NPM changes are now available in the dummy app.
+3. Refresh the browser if the server is already running or start the server using `foreman start` from `react_on_rails/spec/dummy` and navigate to `http://localhost:5000/`. You will now see the `Hello!` message printed in the browser's console.
+
+_Note: running `npm i` automatically builds the npm package before installing. However, when using yarn you will need to run `yarn run build` in the root directory before the install script. This will be updated when yarn issue #2649 (above) is resolved._
+
 # Development Setup for Gem and Node Package Contributors
 
 ## Checklist before Committing
@@ -119,11 +137,13 @@ yarn global add phantomjs
 Note this *must* be installed globally for the dummy test project rspec runner to see it properly.
 
 ### Local Node Package
-Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the test app's root directory and run this command below which runs something like [this script](spec/dummy/package.json#L14)
+Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the dummy app's root directory and run this command below which runs something like [this script](spec/dummy/package.json#L14)
 
 ```sh
+cd react_on_rails/spec/dummy
 yarn run install-react-on-rails
 ```
+_Note: this runs npm under the hood as explained in **Test NPM for react-on-rails** section above_
 
 From now on, the example and dummy apps will use your local node_package folder as the react-on-rails node package. This will also be done automatically for you via the `rake examples:prepare_all` rake task.
 
@@ -141,9 +161,9 @@ From now on, the example and dummy apps will use your local node_package folder
 ### Install NPM dependencies and build the NPM package for react-on-rails
 
 ```sh
-cd <top level>
+cd react_on_rails/
 yarn
-npm build
+yarn build
 ```
 
 Or run this which builds the yarn package, then the webpack files for spec/dummy, and runs tests in
@@ -153,40 +173,40 @@ spec/dummy.
 ```sh
 # Optionally change default selenium_firefox driver
 export DRIVER=poltergeist
-cd <top level>
+cd react_on_rails/
 yarn run dummy:spec
 ```
 
 ### Run NPM JS tests
 
 ```sh
-cd <top level>
+cd react_on_rails/
 yarn test
 ```
 
 ### Run spec/dummy tests
 
 ```sh
-cd spec/dummy
+cd react_on_rails/spec/dummy
 rspec
 ```
 
 Eventually, we may have JS tests:
 
 ```sh
-cd spec/dummy/client
+cd react_on_rails/spec/dummy/client
 yarn run test
 ```
 
 ### Run most tests and linting
 
 ```sh
-cd <top level>
-npm run check
+cd react_on_rails/
+yarn run check
 ```
 
 ### Starting the Dummy App
-To run the test app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start`. If you don't do this, then `webpack` will not generate a new bundle, and you will be seriously confused when you change JavaScript and the app does not change. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `yarn run build`. Since the react-on-rails package should be sym linked, you don't have to `yarn react-on-rails` after every change.
+To run the dummy app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start`. If you don't do this, then `webpack` will not generate a new bundle, and you will be seriously confused when you change JavaScript and the app does not change. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `yarn run build`. Since the react-on-rails package should be sym linked, you don't have to `yarn react-on-rails` after every change.
 
 ### RSpec Testing
 Run `rake` for testing the gem and `spec/dummy`. Otherwise, the `rspec` command only works for testing within the sample apps, like `spec/dummy`.
@@ -195,7 +215,7 @@ If you run `rspec` at the top level, you'll see this message: `require': cannot
 
 After running a test, you can view the coverage results SimpleCov reports by opening `coverage/index.html`.
 
-To test `spec/dummy` against Turbolinks 5, install the gem by running `ENABLE_TURBOLINKS_5=TRUE bundle install` in the `spec/dummy` directory before running `rake`.
+To test `spec/dummy` against Turbolinks 2, install the gem by running `ENABLE_TURBOLINKS_2=TRUE bundle install` in the `spec/dummy` directory before running `rake`. Turbolinks 5 is the default.
 
 Run `rake -T` or `rake -D` to see testing options.
 

data/Gemfile

@@ -22,10 +22,10 @@ gem "sdoc", "~> 0.4.0", group: :doc
 gem "spring"
 gem "sqlite3"
 gem "mini_racer"
-if ENV["ENABLE_TURBOLINKS_5"].nil? || ENV["ENABLE_TURBOLINKS_5"].strip.empty?
-  gem "turbolinks", "2.5.3"
-else
+if ENV["ENABLE_TURBOLINKS_2"].nil? || ENV["ENABLE_TURBOLINKS_2"].strip.empty?
   gem "turbolinks", "~> 5.0"
+else
+  gem "turbolinks", "2.5.3"
 end
 gem "uglifier", ">= 2.7.2"
 gem "web-console", "~> 2.0", group: :development
@@ -35,7 +35,8 @@ gem "rspec-rails"
 gem "rspec-retry"
 gem "capybara"
 gem "capybara-screenshot"
-gem "capybara-webkit"
+# Trouble installing on Sierra
+# gem "capybara-webkit"
 gem "chromedriver-helper"
 gem "launchy"
 gem "poltergeist"

data/docs/additional-reading/rails-assets-relative-paths.md

@@ -157,7 +157,7 @@ module.exports = {
     })
   ],
   module: {
-    loaders: [
+    rules: [
       {
         test: /\.jsx?$/,
         loader: 'babel-loader',
@@ -165,16 +165,24 @@ module.exports = {
       },
       {
         test: require.resolve('react'),
-        loader: 'imports?shim=es5-shim/es5-shim&sham=es5-shim/es5-sham',
+        use: {
+          loader: 'imports-loader',
+          options: {
+            shim: 'es5-shim/es5-shim',
+            sham: 'es5-shim/es5-sham',
+          },
+        }
       },
       {
         // The important stuff
         test: /\.(jpg|jpeg|png)(\?.*)?$/, // Load only .jpg .jpeg, and .png files
-        loader: 'file-loader', 
-        query: {
-          name: '[name][md5:hash].[ext]', // Name of bundled asset
-          outputPath: 'webpack-assets/', // Output location for assets. Final: `app/assets/webpack/webpack-assets/`
-          publicPath: '/assets/webpack-assets/' // Endpoint asset can be found at on Rails server
+        use: {
+          loader: 'file-loader', 
+          options: {
+            name: '[name][md5:hash].[ext]', // Name of bundled asset
+            outputPath: 'webpack-assets/', // Output location for assets. Final: `app/assets/webpack/webpack-assets/`
+            publicPath: '/assets/webpack-assets/' // Endpoint asset can be found at on Rails server
+          }
         }
       }
     ]

data/docs/additional-reading/turbolinks.md

@@ -94,7 +94,7 @@ TURBO: reactOnRailsPageLoaded
 
 Turbolinks 5:
 ```
-TURBO: WITH TURBOLINKS 5: document turbolinks:before-render and turbolinks:load handlers installed. (program)
+TURBO: WITH TURBOLINKS 5: document turbolinks:before-render and turbolinks:render handlers installed. (program)
 TURBO: reactOnRailsPageLoaded
 ```
 

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "6.8.0".freeze
+  VERSION = "6.8.1".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "6.8.0",
+  "version": "6.8.1",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

data/rakelib/dummy_apps.rake

@@ -8,9 +8,9 @@ namespace :dummy_apps do
     sh_in_dir(dummy_app_dir, "yarn install --mutex network")
   end
 
-  task :dummy_app_with_turbolinks_5 do
+  task :dummy_app_with_turbolinks_2 do
     dummy_app_dir = File.join(gem_root, "spec/dummy")
-    bundle_install_with_turbolinks_5_in(dummy_app_dir)
+    bundle_install_with_turbolinks_2_in(dummy_app_dir)
     sh_in_dir(dummy_app_dir, "yarn install --mutex network")
   end
 

data/rakelib/run_rspec.rake

@@ -32,11 +32,11 @@ namespace :run_rspec do
     bundle_install_in(dummy_app_dir)
   end
 
-  desc "Runs dummy respec with turbolinks 5"
-  task dummy_turbolinks_5: ["dummy_apps:dummy_app_with_turbolinks_5"] do
+  desc "Runs dummy respec with turbolinks 2"
+  task dummy_turbolinks_2: ["dummy_apps:dummy_app_with_turbolinks_2"] do
     clean_gen_assets(spec_dummy_dir)
     run_tests_in(spec_dummy_dir, env_vars:
-      "ENABLE_TURBOLINKS_5=TRUE BUNDLE_GEMFILE=#{dummy_app_dir}/Gemfile")
+      "ENABLE_TURBOLINKS_2=TRUE BUNDLE_GEMFILE=#{dummy_app_dir}/Gemfile")
   end
 
   # Dynamically define Rake tasks for each example app found in the examples directory
@@ -62,7 +62,7 @@ namespace :run_rspec do
   end
 
   desc "run all tests no examples"
-  task all_but_examples: [:gem, :dummy, :dummy_no_turbolinks, :dummy_turbolinks_5, :empty, :js_tests] do
+  task all_but_examples: [:gem, :dummy, :dummy_no_turbolinks, :dummy_turbolinks_2, :empty, :js_tests] do
     puts "Completed all RSpec tests"
   end
 

data/rakelib/task_helpers.rb

@@ -28,8 +28,8 @@ module ReactOnRails
       sh_in_dir(dir, "DISABLE_TURBOLINKS=TRUE bundle install")
     end
 
-    def bundle_install_with_turbolinks_5_in(dir)
-      sh_in_dir(dir, "ENABLE_TURBOLINKS_5=TRUE BUNDLE_GEMFILE=#{dir}/Gemfile bundle install")
+    def bundle_install_with_turbolinks_2_in(dir)
+      sh_in_dir(dir, "ENABLE_TURBOLINKS_2=TRUE BUNDLE_GEMFILE=#{dir}/Gemfile bundle install")
     end
 
     # Runs bundle exec using that directory's Gemfile

data/react_on_rails.gemspec

@@ -42,17 +42,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "binding_of_caller"
   s.add_development_dependency "awesome_print"
   s.add_development_dependency "gem-release"
-
-  s.post_install_message = %(
-    React on Rails installed! See https://github.com/shakacode/react_on_rails for documentation
-    and source code.
-
-    You can email contact@shakacode.com for support questions or access to our public slack room.
-
-    For custom application development work or coaching on integrating React with Rails,
-    visit http://www.shakacode.com
-
-    For more information on the generators, run:
-      rails generate react_on_rails:install --help
-  )
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 6.8.0
+  version: 6.8.1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -437,12 +437,7 @@ homepage: https://github.com/shakacode/react_on_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: "\n    React on Rails installed! See https://github.com/shakacode/react_on_rails
-  for documentation\n    and source code.\n\n    You can email contact@shakacode.com
-  for support questions or access to our public slack room.\n\n    For custom application
-  development work or coaching on integrating React with Rails,\n    visit http://www.shakacode.com\n\n
-  \   For more information on the generators, run:\n      rails generate react_on_rails:install
-  --help\n  "
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib