Skip to content

Latest commit

 

History

History
240 lines (202 loc) · 15.7 KB

CHANGELOG.md

File metadata and controls

240 lines (202 loc) · 15.7 KB
Raw

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]

[4.0.0.beta.3] - 2016-03-14

Added
  • 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.
  • 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.
  • The checker for outdated bundles before running tests will default to including the directory with server_bundle_js_file.
  • 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
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)

[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');
Migration Steps v1 to v2

Example of upgrading

  1. Update the react_on_rails gem.
  2. Remove //= require react_on_rails from any files such as app/assets/javascripts/application.js. This file comes from npm now.
  3. 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.
  4. 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.
  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. This includes updating to Babel 6.
  9. 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