Change Log

All notable changes to this project will be documented in this file. Items under Unreleased is upcoming features that will be out in next version.

Contributors: please follow the recommendations outlined at 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

React on Rails server rendering now supports contexts outside of browser rendering, such as ActionMailer templates #486 by eacaps.
React on Rails now correctly parses single-digit version strings from package.json #491 by samphilipd .
Fixed assets symlinking to correctly use filenames with spaces. Begining in #510, ending in #513 by Sergey Tarasov

6.0.5 - 2016-07-11

Added

Added better error messages to avoid issues with shared redux stores #470 by by justin808.

6.0.4 - 2016-06-13

Fixed

Added polyfill for clearTimeout which is used by babel-polyfill #451 by martyphee

6.0.3 - 2016-06-07

Fixed

Added assets symlinking support on Heroku #446 by Alexey Karasev.

6.0.2 - 2016-06-06

Fixed

Fix colisions in ids of DOM nodes generated by react_component by indexing in using an UUID rather than an auto-increment value. This means that it should be overriden using the id parameter of react_component if one wants to generate a predictable id (e.g. for testing purpose). See Issue #437. Fixed in #438 by Michael Baudino.

6.0.1 - 2016-05-27

Fixed

Allow for older version of manifest.json for older versions of sprockets. See Issue #435. Fixed in #436 by alleycat-at-git.

6.0.0 - 2016-05-25

Breaking Changes

Added automatic compilation of assets at precompile is now done by ReactOnRails. Thus, you don't need to provide your own assets.rake file that does the precompilation. #398 by robwise, jbhatab, and justin808.
Migration to v6
- Do not run the generator again if you've already run it.
- See shakacode/react-webpack-rails-tutorial/pull/287 for an example of upgrading from v5.
- To configure the asset compliation you can either
  1. Specify a config/react_on_rails setting for npm_build_production_command to be nil to turn this feature off.
  2. Specify the script command you want to run to build your production assets, and remove your assets.rake file.
- If you are using the ReactOnRails test helper, then you will need to add the 'config.npm_build_test_command' to your config to tell react_on_rails what command to run when you run rspec.
See shakacode/react-webpack-rails-tutorial #287 for an upgrade example. The PR has a few comments on the upgrade.

Here is the addition to the generated config file:

  # This configures the script to run to build the production assets by webpack. Set this to nil
  # if you don't want react_on_rails building this file for you.
  config.npm_build_production_command = "npm run build:production"

  # If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
  # with rspec then this controls what npm command is run
  # to automatically refresh your webpack assets on every test run.
  config.npm_build_test_command = "npm run build:test"

Fixed

Fixed errors when server rendered props contain \u2028 or \u2029 characters #375 by mariusandra
Fixed "too early unmount" which caused problems with Turbolinks 5 not updating the screen #425 by szyablitsky

Added

Experimental ability to use node.js process for server rendering. See #380 by alleycat-at-git.
Non-digested version of assets in public folder #413 by alleycat-at-git.
Cache client/node_modules directory to prevent Heroku from reinstalling all modules from scratch #324 by modosc.
ReactOnRails.reactOnRailsPageLoaded() is exposed in case one needs to call this manually and information on async script loading added. See #315 by SqueezedLight.

Changed

#398 by robwise, jbhatab, and justin808 contains:
- Only one webpack config is generated for server and client config. Package.json files were changed to reflect this.
- Added npm_build_test_command to allow developers to change what npm command is automatically run from rspec.
Replace URI with Addressable gem. See #405 by lucke84

Removed

#398 by robwise, jbhatab, and justin808 contains:
- Server rendering is no longer an option in the generator and is always accessible.
- Removed lodash, jquery, and loggerMiddleware from the generated code.
- Removed webpack watch check for test helper automatic compilation.

5.2.0 - 2016-04-08

Added

Support for React 15.0 to react_on_rails. See #379 by brucek.
Support for Node.js server side rendering. See #380 by alleycat and doc

Removed

Generator removals to simplify installer. See #363 by jbhatab.
- Removed options for heroku, boostrap, and the linters from generator.
- Removed install for the Webpack Dev Server, as we can now do hot reloading with Rails, so the complexity of this feature is not justified. Nevertheless, the setup of React on Rails still supports this setup, just not with the generator.
- Documentation added for removed installer options.

5.1.1 - 2016-04-04

Fixed

Security Fixes: Address failure to sanitize console messages when server rendering and displaying in the browser console. See #366 and #370 by justin808

Added

railsContext includes the port number and a boolean if the code is being run on the server or client.

5.1.0 - 2016-04-03

Added

All 5.1.0 changes can be found in #362 by justin808.

Generator enhancements
- Generator adds line to spec/rails_helper.rb so that running specs will ensure assets are compiled.
- Other small changes to the generator including adding necessary npm scripts to allow React on Rails to build assets.
- Npm modules updated for generator.
- Added babel-runtime in to the client/package.json created.
Server rendering
- Added more diagnostics for server rendering.
- Calls to setTimeout and setInterval are not logged for server rendering unless env TRACE_REACT_ON_RAILS is set to YES.
Updated all project npm dependencies to latest.
Update to node 5.10.0 for CI.
Added babel-runtime as a peer dependency for the npm module.

5.0.0 - 2016-04-01

Added

Added railsContext, an object which gets passed always as the second parameter to both react component and redux store generator functions, both for server and client rendering. This provides data like the current locale, the pathname, etc. The data values are customizable by a new configuration called rendering_extension where you can create a module with a method called rendering_extension. This allows you to add additional values to the Rails Context. Implement one static method called custom_context(view_context) and return a Hash. See #345 by justin808

Changed

Previously, you could pass arbitrary additional html attributes to react_component. Now, you need to pass them in as a named parameter html_options to react_component.

Breaking Changes

You must provide named attributes, including props for view helper react_compnent. See [this commit]](https://github.com/shakacode/react-webpack-rails-tutorial/commit/a97fa90042cbe27be7fd7fa70b5622bfcf9c3673) for an example migration used for www.reactrails.com.

4.0.3 - 2016-03-17

Fixed

ReactOnRailsHelper#react_component: Invalid deprecation message when called with only one paramter, the component name.

4.0.2 - 2016-03-17

Fixed

ReactOnRails::Controller#redux_store: 2nd parameter changed to a named parameter props for consistency.

4.0.1 - 2016-03-16

Fixed

Switched to heroku buildpacks:set syntax rather than using a .buildpacks file, which is deprecated. See #319 by esauter5. Includes both generator and doc updates.

4.0.0 - 2016-03-14

Added

spec/dummy is a full sample app of React on Rails techniques including the hot reloading of assets from Rails!
Added helpers env_stylesheet_link_tag and env_javascript_include_tag to support hot reloading Rails. See the README.md for more details and see the example application in spec/dummy. Also see how this is used in the tutorial: application.html.erb
Added optional parameter for ReactOnRails.getStore(name, throwIfMissing = true) so that you can check if a store is defined easily.
Added controller module ReactOnRails::Controller. Adds method redux_store to setup redux stores in the view.
Added option defer: true for view helper redux_store. This allows the view helper to specify the props for store hydration, yet still render the props at the bottom of the view.
Added view helper redux_store_hydration_data to render the props on the application's layout, near the bottom. This allows for the client hydration data to be parsed after the server rendering, which may result in a faster load time.
The checker for outdated bundles before running tests will two configuration options: generated_assets_dir and webpack_generated_files.
Better support for Turbolinks 5!
Fixed generator check of uncommitted code for foreign languages. See #303 by nmatyukov.
Added several parameters used for ensuring webpack assets are built for running tests:
- config.generated_assets_dir: Directory where your generated webpack assets go. You can have only one directory for this.
- config.webpack_generated_files: List of files that will get created in the generated_assets_dir. The test runner helper will ensure these generated files are newer than any of the files in the client directory.

Changed

Generator default for webpack generated assets is now app/assets/webpack as we use this for both JavaScript and CSS generated assets.

Fixed

The test runner "assets up to date checker" is greatly improved.
Lots of doc updates!
Improved the spec/dummy sample app so that it supports CSS modules, hot reloading, etc, and it can server as a template for a new ReactOnRails installation.

Breaking Changes

Deprecated calling redux_store(store_name, props). The API has changed. Use redux_store(store_name, props: props, defer: false) A new option called defer allows the rendering of store hydration at the bottom of the your layout. Place redux_store_hydration_data on your layout.
config.server_bundle_js_file has changed. The default value is now blank, meaning no server rendering. Addtionally, if you specify the file name, you should not include the path, as that should be specified in the config.generated_assets_dir.
config.generated_assets_dirs has been renamed to config.generated_assets_dir (singular) and it only takes one directory.

3.0.6 - 2016-03-01

Fixed

Improved errors when registered store is not found. See #301 by justin808.

3.0.5 - 2016-02-26

Fixed

Fixed error in linters rake file for generator. See #299 by mpugach.

3.0.4 - 2016-02-25

Fixed

Updated CHANGELOG.md to include contributors for each PR.
Fixed config.server_bundle_js file value in generator to match generator setting of server rendering. See #295 by aaronvb.

3.0.3 - 2016-02-21

Fixed

Cleaned up code in spec/dummy to latest React and Redux APIs. See #282.
Update generator messages with helpful information. See #279.
Other small generated comment fixes and doc fixes.

3.0.2 - 2016-02-15

Fixed

Fixed missing information in the helpful message after running the base install generator regarding how to run the node server with hot reloading support.

3.0.1 - 2016-02-15

Fixed

Fixed several jscs linter issues.

3.0.0 - 2016-02-15

Fixed

Fix Bootstrap Sass Append to Gemfile, missing new line. #262.

Added

Added helper redux_store and associated JavaScript APIs that allow multiple React components to use the same store. Thus, you initialize the store, with props, separately from the components.
Added forman to gemspec in case new dev does not have it globally installed. #248.
Support for Turbolinks 5! #270.
Added better error messages for ReactOnRails.register(). #273.

Breaking Change

Calls to react_component should use a named argument of props. For example, change this:

<%= react_component("ReduxSharedStoreApp", {}, prerender: false, trace: true) %>

to

<%= react_component("ReduxSharedStoreApp", props: {}, prerender: false, trace: true) %>

You'll get a deprecation message to change this.

Renamed ReactOnRails.configure_rspec_to_compile_assets to ReactOnRails::TestHelper.configure_rspec_to_compile_assets. The code has also been optimized to check for whether or not the compiled webpack bundles are up to date or not and will not run if not necessary. If you are using non-standard directories for your generated webpack assets (app/assets/javascripts/generated and app/assets/stylesheets/generated) or have additional directories you wish the helper to check, you need to update your ReactOnRails configuration accordingly. See documentation for how to do this. #253.
You have to call ReactOnRails.register to register react components. This was deprecated in v2. #273.

Migration Steps v2 to v3

spec/dummy/spec/rails_helper.rb for an example. Add this line to your rails_helper.rb:

RSpec.configure do |config|
  # Ensure that if we are running js tests, we are using latest webpack assets
  ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)

Change view helper calls to react_component to use the named param of props. See forum post Using Regexp to update to ReactOnRails v3.

2.3.0 - 2016-02-01

Added

Added polyfills for setInterval and setTimeout in case other libraries expect these to exist.
Added much improved debugging for errors in the server JavaScript webpack file.
See #244 for these improvements.

2.2.0 - 2016-01-29

Added

New JavaScript API for debugging TurboLinks issues. Be sure to see turbolinks docs. ReactOnRails.setOptions({ traceTurbolinks: true });. Removed the file debug_turbolinks added in 2.1.1. See #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.
debug_turbolinks helper for debugging turbolinks issues. See turbolinks.
Enhanced regression testing for non-turbolinks apps. Runs all tests for dummy app with turbolinks both disabled and enabled.

2.1.0 - 2016-01-26

Added

Added EnsureAssetsCompiled feature so that you do not accidentally run tests without properly compiling the JavaScript bundles. Add a line to your rails_helper.rb file to check that the latest Webpack bundles have been generated prior to running tests that may depend on your client-side code. See docs for more detailed instructions. #222
Added migration guide for migrating from React-Rails. #219
Added React on Rails Doctrine to docs. Discusses the project's motivations, conventions, and principles. #220
Added ability to skip display:none style in the generated content tag for a component. Some developers may want to disable inline styles for security reasons. See generated config initializer file for example on setting skip_display_none. #218

Changed

Changed message when running the dev (a.k.a. "express" server). #227

Fixed

Fixed handling of Turbolinks. Code was checking that Turbolinks was installed when it was not yet because some setups load Turbolinks after the bundles. The changes to the code will check if Turbolinks is installed after the page loaded event fires. Code was also added to allow easy debugging of Turbolinks, which should be useful when v5 of Turbolinks is released shortly. Details of how to configure Turbolinks with troubleshooting were added to docs/additional-reading/turbolinks.md. #221
Fixed issue with already initialized constant warning appearing when starting a Rails server #226
Fixed to make backwards compatible with Ruby v2.0 and updated all Ruby and Node dependencies.

2.0.2

Added better messages after generator runs. #210

2.0.1

Fixed bug with version matching between gem and npm package.

2.0.0

Move JavaScript part of react_on_rails to npm package 'react-on-rails'.
Converted JavaScript code to ES6! with tests!
No global namespace pollution. ReactOnRails is the only global added.
New API. Instead of placing React components on the global namespace, you instead call ReactOnRails.register, passing an object where keys are the names of your components:

import ReactOnRails from 'react-on-rails';
ReactOnRails.register({name: component});

Best done with Object destructing:

  import ReactOnRails from 'react-on-rails';
  ReactOnRails.register(
    {
      Component1,
      Component2
    }
  );

Previously, you used

window.Component1 = Component1;
window.Component2 = Component2;

This would pollute the global namespace. See details in the README.md for more information.

Your jade template for the WebpackDevServer setup should use the new API:

  ReactOnRails.render(componentName, props, domNodeId);

such as:

  ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app');

All npm dependency libraries updated. Most notable is going to Babel 6.
Dropped support for react 0.13.
JS Linter uses ShakaCode JavaScript style: https://github.com/shakacode/style-guide-javascript
Generators account these differences.

Migration Steps v1 to v2

Example of upgrading

Update the react_on_rails gem.
Remove //= require react_on_rails from any files such as app/assets/javascripts/application.js. This file comes from npm now.
Search you app for 'generator_function' and remove lines in layouts and rb files that contain it. Determination of a generator function is handled automatically.
Find your files where you registered client and server globals, and use the new ReactOnRails.register syntax. Optionally rename the files clientRegistration.jsx and serverRegistration.jsx rather than Globals.
Update your index.jade to use the new API ReactOnRails.render("MyApp", !{props}, 'app');
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.
Run cd client && npm i --save react-on-rails to get react-on-rails into your client/package.json.
You should also update any other dependencies if possible to match up with the react-webpack-rails-tutorial. This includes updating to Babel 6.
If you want to stick with Babel 5 for a bit, see Issue #238.

1.2.2

Fixed

Missing Lodash from generated package.json #175
Rails 3.2 could not run generators #182
Better placement of jquery_ujs dependency #171
Add more detailed description when adding --help option to generator #161
Lots of better docs.

1.2.0

Added

Support --skip-bootstrap or -b option for generator.
Create examples tasks to test generated example apps.

Fixed

Fix non-server rendering configuration issues.
Fix application.js incorrect overwritten issue.
Fix Gemfile dependencies.
Fix several generator issues.

Removed

Removed templates/client folder.

1.1.1 - 2015-11-28

Added

Support for React Router.
Error and redirect handling.
Turbolinks support.

Fixed

Fix several generator related issues.

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Change Log

Unreleased

6.0.5 - 2016-07-11

Added

6.0.4 - 2016-06-13

Fixed

6.0.3 - 2016-06-07

Fixed

6.0.2 - 2016-06-06

Fixed

6.0.1 - 2016-05-27

Fixed

6.0.0 - 2016-05-25

Breaking Changes

Fixed

Added

Changed

Removed

5.2.0 - 2016-04-08

Added

Removed

5.1.1 - 2016-04-04

Fixed

Added

5.1.0 - 2016-04-03

Added

5.0.0 - 2016-04-01

Added

Changed

Breaking Changes

4.0.3 - 2016-03-17

Fixed

4.0.2 - 2016-03-17

Fixed

4.0.1 - 2016-03-16

Fixed

4.0.0 - 2016-03-14

Added

Changed

Fixed

Breaking Changes

3.0.6 - 2016-03-01

Fixed

3.0.5 - 2016-02-26

Fixed

3.0.4 - 2016-02-25

Fixed

3.0.3 - 2016-02-21

Fixed

3.0.2 - 2016-02-15

Fixed

3.0.1 - 2016-02-15

Fixed

3.0.0 - 2016-02-15

Fixed

Added

Breaking Change

Migration Steps v2 to v3

2.3.0 - 2016-02-01

Added

2.2.0 - 2016-01-29

Added

2.1.1 - 2016-01-28

Fixed

Added

2.1.0 - 2016-01-26

Added

Changed

Fixed

2.0.2

2.0.1

2.0.0

Migration Steps v1 to v2

1.2.2