react_on_rails 11.2.1 → 12.0.0.pre.beta.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +320 -0
- data/.eslintignore +2 -1
- data/.eslintrc +23 -1
- data/.github/FUNDING.yml +1 -0
- data/.gitignore +3 -1
- data/.prettierignore +10 -1
- data/.prettierrc +3 -0
- data/.rubocop.yml +37 -11
- data/.travis.yml +10 -20
- data/CHANGELOG.md +85 -9
- data/CONTRIBUTING.md +60 -71
- data/Gemfile +3 -4
- data/{COMM-LICENSE → REACT-ON-RAILS-PRO-LICENSE} +6 -9
- data/README.md +121 -71
- data/Rakefile +0 -7
- data/SUMMARY.md +9 -12
- data/book.json +5 -5
- data/docs/additional-reading/asset-pipeline.md +8 -16
- data/docs/additional-reading/react-helmet.md +30 -10
- data/docs/additional-reading/react-router.md +52 -75
- data/docs/additional-reading/server-rendering-tips.md +12 -7
- data/docs/api/javascript-api.md +3 -3
- data/docs/api/redux-store-api.md +4 -2
- data/docs/api/view-helpers-api.md +8 -9
- data/docs/basics/configuration.md +68 -59
- data/docs/basics/deployment.md +1 -2
- data/docs/basics/hmr-and-hot-reloading-with-the-webpack-dev-server.md +49 -0
- data/docs/basics/i18n.md +44 -22
- data/docs/basics/installation-into-an-existing-rails-app.md +2 -2
- data/docs/basics/minitest-configuration.md +31 -0
- data/docs/basics/react-server-rendering.md +1 -1
- data/docs/basics/{generator-functions-and-railscontext.md → render-functions-and-railscontext.md} +59 -21
- data/docs/basics/rspec-configuration.md +29 -17
- data/docs/basics/upgrading-react-on-rails.md +67 -3
- data/docs/basics/webpack-configuration.md +15 -1
- data/docs/contributor-info/errors-with-hooks.md +45 -0
- data/docs/contributor-info/pull-requests.md +44 -0
- data/docs/misc/doctrine.md +1 -1
- data/docs/{misc-pending → outdated}/code-splitting.md +12 -8
- data/docs/{additional-reading → outdated}/heroku-deployment.md +0 -6
- data/docs/{basics → outdated}/how-react-on-rails-works.md +3 -3
- data/docs/{misc-pending → outdated}/manual-installation-overview.md +5 -5
- data/docs/{additional-reading → outdated}/rails-assets-relative-paths.md +3 -3
- data/docs/{misc-pending → outdated}/rails-assets.md +4 -7
- data/docs/{misc → outdated}/rails3.md +0 -0
- data/docs/testimonials/resortpass.md +13 -0
- data/docs/testimonials/testimonials.md +11 -1
- data/docs/tutorial.md +96 -70
- data/jest.config.js +4 -0
- data/lib/generators/react_on_rails/base_generator.rb +2 -2
- data/lib/generators/react_on_rails/dev_tests_generator.rb +1 -1
- data/lib/generators/react_on_rails/generator_helper.rb +4 -6
- data/lib/generators/react_on_rails/templates/base/base/Procfile.dev +3 -1
- data/lib/generators/react_on_rails/templates/base/base/Procfile.dev-hmr +26 -0
- data/lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.jsx +20 -40
- data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb +2 -1
- data/lib/generators/react_on_rails/templates/redux/base/app/javascript/bundles/HelloWorld/components/HelloWorld.jsx +4 -8
- data/lib/generators/react_on_rails/templates/redux/base/app/javascript/bundles/HelloWorld/store/helloWorldStore.js +1 -3
- data/lib/react_on_rails.rb +3 -1
- data/lib/react_on_rails/configuration.rb +13 -22
- data/lib/react_on_rails/error.rb +2 -0
- data/lib/react_on_rails/helper.rb +100 -143
- data/lib/react_on_rails/json_parse_error.rb +2 -0
- data/lib/react_on_rails/locales/base.rb +150 -0
- data/lib/react_on_rails/locales/to_js.rb +37 -0
- data/lib/react_on_rails/locales/to_json.rb +27 -0
- data/lib/react_on_rails/prerender_error.rb +11 -15
- data/lib/react_on_rails/react_component/render_options.rb +4 -0
- data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb +41 -46
- data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb +7 -8
- data/lib/react_on_rails/utils.rb +14 -19
- data/lib/react_on_rails/version.rb +1 -1
- data/lib/react_on_rails/version_checker.rb +1 -0
- data/lib/react_on_rails/webpacker_utils.rb +13 -2
- data/lib/tasks/assets.rake +19 -44
- data/lib/tasks/locale.rake +4 -2
- data/package-scripts.yml +11 -8
- data/package.json +29 -28
- data/rakelib/dummy_apps.rake +1 -9
- data/rakelib/example_type.rb +3 -1
- data/rakelib/examples.rake +3 -0
- data/rakelib/lint.rake +2 -7
- data/rakelib/node_package.rake +2 -2
- data/rakelib/release.rake +0 -6
- data/rakelib/run_rspec.rake +5 -18
- data/react_on_rails.gemspec +3 -5
- data/tsconfig.json +14 -0
- data/webpackConfigLoader.js +3 -2
- data/yarn.lock +4170 -2197
- metadata +34 -57
- data/Gemfile.rails32 +0 -73
- data/docs/additional-reading/babel.md +0 -5
- data/docs/additional-reading/hot-reloading-rails-development-asset-pipeline.md +0 -47
- data/docs/api/ruby-api-hot-reload-view-helpers.md +0 -44
- data/lib/generators/react_on_rails/templates/base/base/Procfile.dev-server +0 -12
- data/lib/react_on_rails/assets_precompile.rb +0 -153
- data/lib/react_on_rails/locales_to_js.rb +0 -138
data/docs/basics/deployment.md
CHANGED
@@ -2,5 +2,4 @@
|
|
2
2
|
|
3
3
|
- React on Rails puts the necessary precompile steps automatically in the rake precompile step. You can, however, disable this by setting certain values to nil in the [config/initializers/react_on_rails.rb](./configuration.md).
|
4
4
|
- `build_production_command`: Set to nil to turn off the precompilation of the js assets.
|
5
|
-
|
6
|
-
- See the [Heroku Deployment](../additional-reading/heroku-deployment.md) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.
|
5
|
+
- See the [Heroku Deployment](docs/outdated/heroku-deployment.md) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# HMR and Hot Reloading with the webpack-dev-server
|
2
|
+
|
3
|
+
The webpack-dev-server provides:
|
4
|
+
|
5
|
+
1. Speedy compilation of client side assets
|
6
|
+
2. Optional HMR which means that the page will reload automatically when after
|
7
|
+
compilation completes. Note, some developers do not like this, as you'll
|
8
|
+
abruptly lose any tweaks within the Chrome development tools.
|
9
|
+
3. Optional hot-reloading. The older react-hot-loader has been deprecated in
|
10
|
+
favor of [fast-refresh](https://reactnative.dev/docs/fast-refresh).
|
11
|
+
For use with webpack, see [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin).
|
12
|
+
|
13
|
+
If you are ***not*** using server-side rendering (***not*** using `prerender: true`),
|
14
|
+
then you can follow all the regular docs for using the `bin/webpack-dev-server`
|
15
|
+
during development.
|
16
|
+
|
17
|
+
|
18
|
+
# Server Side Rendering with the Default rails/webpacker bin/webpack-dev-server
|
19
|
+
|
20
|
+
If you are using server-side rendering, then you have a couple options. The
|
21
|
+
recommended technique is to have a different webpack configuration for server
|
22
|
+
rendering.
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
|
27
|
+
## If you use the same Webpack setup for your server and client bundles
|
28
|
+
If you do use the webpack-dev-server for prerendering, be sure to set the
|
29
|
+
`config/initializers/react_on_rails.rb` setting of
|
30
|
+
|
31
|
+
```
|
32
|
+
config.same_bundle_for_client_and_server = true
|
33
|
+
```
|
34
|
+
|
35
|
+
`dev_server.hmr` maps to [devServer.hot](https://webpack.js.org/configuration/dev-server/#devserverhot).
|
36
|
+
This must be false if you're using the webpack-dev-server for client and server bundles.
|
37
|
+
|
38
|
+
`dev_server.inline` maps to [devServer.inline](https://webpack.js.org/configuration/dev-server/#devserverinline).
|
39
|
+
This must also be false.
|
40
|
+
|
41
|
+
If you don't configure these two to false, you'll see errors like:
|
42
|
+
|
43
|
+
* "ReferenceError: window is not defined" (if hmr is true)
|
44
|
+
* "TypeError: Cannot read property 'prototype' of undefined" (if inline is true)
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
|
data/docs/basics/i18n.md
CHANGED
@@ -1,23 +1,10 @@
|
|
1
|
-
#
|
1
|
+
# I18n
|
2
2
|
|
3
3
|
Here's a summary of adding the I18n functionality.
|
4
4
|
|
5
|
-
|
5
|
+
1. Add `config.i18n_dir` in `config/initializers/react_on_rails.rb`
|
6
6
|
|
7
|
-
|
8
|
-
|
9
|
-
```js
|
10
|
-
"dependencies": {
|
11
|
-
...
|
12
|
-
"intl": "^1.2.5",
|
13
|
-
"react-intl": "^2.1.5",
|
14
|
-
...
|
15
|
-
}
|
16
|
-
```
|
17
|
-
|
18
|
-
2. Add `config.i18n_dir` in `config/initializers/react_on_rails.rb`
|
19
|
-
|
20
|
-
`react-intl` requires locale files in json format. React on Rails will generate `translations.js` & `default.js` automatically after you configured your `config.i18n_dir` in `config/initializers/react_on_rails.rb`.
|
7
|
+
React on Rails will generate `translations.json` & `default.json` automatically (see #3) after you configured your `config.i18n_dir` in `config/initializers/react_on_rails.rb`.
|
21
8
|
|
22
9
|
```ruby
|
23
10
|
# Replace the following line to the location where you keep translation.js & default.js.
|
@@ -31,16 +18,49 @@ You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/rea
|
|
31
18
|
config.i18n_yml_dir = Rails.root.join("PATH_TO", "YOUR_YAML_I18N_FOLDER")
|
32
19
|
```
|
33
20
|
|
34
|
-
`translations.
|
35
|
-
`default.
|
21
|
+
`translations.json`: All your locales in json format.
|
22
|
+
`default.json`: Default settings in json format.
|
36
23
|
|
37
|
-
|
24
|
+
2. Add `translations.json` and `default.json` to your `.gitignore`.
|
25
|
+
|
26
|
+
3. Javascript locale files must be generated before `yarn build`.
|
27
|
+
|
28
|
+
Once you setup `config.i18n_dir` as in the previous step, react_on_rails will automatically do this for testing (if using the `ReactOnRails::TestHelper.configure_rspec_to_compile_assets` and for production deployments if using the [default precompile rake hook](docs/outdated/heroku-deployment.md).
|
29
|
+
|
30
|
+
For development, you should adjust your startup scripts (Procfiles) so that they run **`bundle exec rake react_on_rails:locale`** before running any webpack watch process (`yarn run build:development`).
|
31
|
+
|
32
|
+
You may need to configure your CI to run **`bundle exec rake react_on_rails:locale`** before any webpack process if you are not using the React on Rails test helper.
|
33
|
+
|
34
|
+
Note, if you are try to lint before running tests, and you are depending on the test helper to build your locales, your linting will fail because the translations won't be built yet.
|
35
|
+
|
36
|
+
The fix is either to
|
37
|
+
1) run the rake task to build the translations before running the lint command or
|
38
|
+
2) to run the tests first.
|
39
|
+
|
40
|
+
# Generate locales with react-intl support
|
41
|
+
|
42
|
+
By default the locales generated in json format. If you need to generate files in the prior way
|
43
|
+
with `react-intl` supported via js files:
|
38
44
|
|
39
|
-
|
45
|
+
1. Specify i18n output format in `react_on_rails.rb`:
|
46
|
+
```rb
|
47
|
+
config.i18n_output_format = 'js'
|
48
|
+
```
|
49
|
+
|
50
|
+
2. Add `react-intl` & `intl` to `client/package.json`, and remember to `bundle && yarn install`.
|
51
|
+
|
52
|
+
```js
|
53
|
+
"dependencies": {
|
54
|
+
...
|
55
|
+
"intl": "^1.2.5",
|
56
|
+
"react-intl": "^2.1.5",
|
57
|
+
...
|
58
|
+
}
|
59
|
+
```
|
40
60
|
|
41
|
-
|
61
|
+
3. Add `translations.js` and `default.js` to your `.gitignore` and `.eslintignore`.
|
42
62
|
|
43
|
-
|
63
|
+
4. In React, you need to initialize `react-intl`, and set parameters for it.
|
44
64
|
|
45
65
|
```js
|
46
66
|
...
|
@@ -74,4 +94,6 @@ You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/rea
|
|
74
94
|
|
75
95
|
# Notes
|
76
96
|
|
97
|
+
* See why using JSON could be better compare to JS if amount of data is hure [ https://v8.dev/blog/cost-of-javascript-2019#json]( https://v8.dev/blog/cost-of-javascript-2019#json).
|
77
98
|
* See [Support for Rails' i18n pluralization #1000](https://github.com/shakacode/react_on_rails/issues/1000) for a discussion of issues around pluralization.
|
99
|
+
* [Outdated] You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and [PR #340](https://github.com/shakacode/react-webpack-rails-tutorial/pull/340), [commmited](https://github.com/shakacode/react-webpack-rails-tutorial/commit/ef369ed9d922aea5116ca7e50208169fd7831389) for a complete example.
|
@@ -11,7 +11,7 @@
|
|
11
11
|
gem "webpacker", "~> 3" # Newer versions might be supported
|
12
12
|
```
|
13
13
|
|
14
|
-
2. Run the following 2 commands to install Webpacker with React. Note,
|
14
|
+
2. Run the following 2 commands to install Webpacker with React. Note, if you are using an older version of Rails than 5.1, you'll need to install webpacker with React per the instructions [here](https://github.com/rails/webpacker).
|
15
15
|
|
16
16
|
|
17
17
|
```bash
|
@@ -45,7 +45,7 @@
|
|
45
45
|
|
46
46
|
## Installation
|
47
47
|
|
48
|
-
See the [Installation Overview](
|
48
|
+
See the [Installation Overview](docs/outdated/manual-installation-overview.md) for a concise set summary of what's in a React on Rails installation.
|
49
49
|
|
50
50
|
|
51
51
|
## NPM
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# Minitest Configuration
|
2
|
+
|
3
|
+
The setup for minitest is the same as for rspec with the following difference.
|
4
|
+
|
5
|
+
Rather than calling `ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)`, instead you will do something like this:
|
6
|
+
|
7
|
+
```ruby
|
8
|
+
class ActiveSupport::TestCase
|
9
|
+
setup do
|
10
|
+
ReactOnRails::TestHelper.ensure_assets_compiled
|
11
|
+
end
|
12
|
+
end
|
13
|
+
```
|
14
|
+
|
15
|
+
|
16
|
+
Or maybe something like this, from the [minitest docs](https://github.com/seattlerb/minitest/blob/master/lib/minitest/test.rb#L119):
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
module MyMinitestPlugin
|
20
|
+
def before_setup
|
21
|
+
super
|
22
|
+
ReactOnRails::TestHelper.ensure_assets_compiled
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
class MiniTest::Test
|
27
|
+
include MyMinitestPlugin
|
28
|
+
end
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -10,7 +10,7 @@ During the Rails rendering of HTML per a browser request, the Rails server will
|
|
10
10
|
|
11
11
|
The default JavaScript interpretter is [ExecJS](https://github.com/rails/execjs). If you want to maximize the perfomance of your server rendering, then you want to use React on Rails Pro which uses NodeJS to do the server rendering. See the [docs for React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
|
12
12
|
|
13
|
-
See [this note](
|
13
|
+
See [this note](docs/outdated/how-react-on-rails-works.md#client-side-rendering-vs-server-side-rendering)
|
14
14
|
|
15
15
|
|
16
16
|
## How do you do Server Rendering with React on Rails?
|
data/docs/basics/{generator-functions-and-railscontext.md → render-functions-and-railscontext.md}
RENAMED
@@ -1,45 +1,80 @@
|
|
1
|
-
#
|
1
|
+
# Render-Functions and the Rails Context
|
2
2
|
|
3
|
-
##
|
3
|
+
## Render-Functions
|
4
4
|
|
5
|
-
When you use a
|
5
|
+
When you use a render-function to create react components (or renderedHtml on the server), or you
|
6
|
+
used shared redux stores, you get two params passed to your function that creates a React component:
|
6
7
|
|
7
8
|
1. `props`: Props that you pass in the view helper of either `react_component` or `redux_store`
|
8
|
-
2. `railsContext`: Rails contextual information, such as the current pathname. You can customize
|
9
|
+
2. `railsContext`: Rails contextual information, such as the current pathname. You can customize
|
10
|
+
this in your config file. **Note**: The `railsContext` is not related to the concept of a
|
11
|
+
["context" for React components](https://facebook.github.io/react/docs/context.html#how-to-use-context).
|
9
12
|
|
10
|
-
|
13
|
+
These parameters (`props` and `railsContext`) will be the same regardless of either client or server
|
14
|
+
side rendering, except for the key `serverSide` based on whether or not you are server rendering.
|
11
15
|
|
12
|
-
While you could manually configure your Rails code to pass the "`railsContext` information" with
|
16
|
+
While you could manually configure your Rails code to pass the "`railsContext` information" with
|
17
|
+
the rest of your "props", the `railsContext` is a convenience because it's passed consistently to
|
18
|
+
all invocations of render functions.
|
13
19
|
|
14
|
-
For example, suppose you create a "
|
20
|
+
For example, suppose you create a "render-function" called MyAppComponent.
|
15
21
|
|
16
22
|
```js
|
17
23
|
import React from 'react';
|
18
24
|
const MyAppComponent = (props, railsContext) => (
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
25
|
+
// NOTE: need to wrap in a function so this is proper React function component that can use
|
26
|
+
// hooks
|
27
|
+
|
28
|
+
// the props get passed again, but we ignore since we use a closure
|
29
|
+
// or should we
|
30
|
+
() =>
|
31
|
+
<div>
|
32
|
+
<p>props are: {JSON.stringify(props)}</p>
|
33
|
+
<p>railsContext is: {JSON.stringify(railsContext)}
|
34
|
+
</p>
|
35
|
+
</div>
|
24
36
|
);
|
25
37
|
export default MyAppComponent;
|
26
38
|
```
|
27
39
|
|
40
|
+
------------------------------
|
41
|
+
|
42
|
+
_This would be alternate API where you have to call React.createElement and the React on Rails code doesn't do that._
|
43
|
+
|
44
|
+
```js
|
45
|
+
import React from 'react';
|
46
|
+
const MyAppComponent = (props, railsContext) => (
|
47
|
+
// NOTE: need to wrap in a function so this is proper React function component that can use
|
48
|
+
// hooks
|
49
|
+
React.createElement(
|
50
|
+
() =>
|
51
|
+
<div>
|
52
|
+
<p>props are: {JSON.stringify(props)}</p>
|
53
|
+
<p>railsContext is: {JSON.stringify(railsContext)}
|
54
|
+
</p>
|
55
|
+
</div>,
|
56
|
+
props)
|
57
|
+
);
|
58
|
+
export default MyAppComponent;
|
59
|
+
```
|
60
|
+
|
61
|
+
------------------------------------
|
62
|
+
|
28
63
|
*Note: you will get a React browser console warning if you try to serverRender this since the value of `serverSide` will be different for server rendering.*
|
29
64
|
|
30
|
-
So if you register your
|
65
|
+
So if you register your render-function `MyAppComponent`, it will get called like:
|
31
66
|
|
32
67
|
```js
|
33
68
|
reactComponent = MyAppComponent(props, railsContext);
|
34
69
|
```
|
35
70
|
|
36
|
-
and, similarly, any redux store always initialized with 2 parameters:
|
71
|
+
and, similarly, any redux store is always initialized with 2 parameters:
|
37
72
|
|
38
73
|
```js
|
39
74
|
reduxStore = MyReduxStore(props, railsContext);
|
40
75
|
```
|
41
76
|
|
42
|
-
Note: you never make these calls. React on Rails makes these calls when it does either client or server rendering. You will define functions that take these 2 params and return a React component or a Redux Store. Naturally, you do not have to use second parameter of the railsContext if you do not need it.
|
77
|
+
Note: you never make these calls. React on Rails makes these calls when it does either client or server rendering. You will define functions that take these 2 params and return a React component or a Redux Store. Naturally, you do not have to use second parameter of the railsContext if you do not need it. If you don't take a second parameter, then you're probably defining a React function component and you will simply return a React Element, often just JSX.
|
43
78
|
|
44
79
|
(Note: see below [section](#multiple-react-components-on-a-page-with-one-store) on how to setup redux stores that allow multiple components to talk to the same store.)
|
45
80
|
|
@@ -76,7 +111,7 @@ Plus, you can add your customizations to this. See "rendering extension" below.
|
|
76
111
|
|
77
112
|
## Rails Context
|
78
113
|
|
79
|
-
The `railsContext` is a second param passed to your
|
114
|
+
The `railsContext` is a second param passed to your render-functions for React components. This is in addition to the props that are passed from the `react_component` Rails helper. For example:
|
80
115
|
|
81
116
|
ERB view file:
|
82
117
|
|
@@ -91,7 +126,8 @@ This is what your HelloWorld.js file might contain. The railsContext is always a
|
|
91
126
|
import React from 'react';
|
92
127
|
|
93
128
|
export default (props, railsContext) => {
|
94
|
-
|
129
|
+
// Note, wrap in a function so this is React function component
|
130
|
+
return () => (
|
95
131
|
<div>
|
96
132
|
Your locale is {railsContext.i18nLocale}.<br/>
|
97
133
|
Hello, {props.name}!
|
@@ -100,15 +136,17 @@ export default (props, railsContext) => {
|
|
100
136
|
};
|
101
137
|
```
|
102
138
|
|
103
|
-
## Why is the railsContext
|
139
|
+
## Why is the railsContext only passed to render-functions?
|
104
140
|
|
105
|
-
There's no reason that the railsContext would ever get passed to your React component unless the value is explicitly put into the props used for rendering. If you create a react component, rather than a
|
141
|
+
There's no reason that the railsContext would ever get passed to your React component unless the value is explicitly put into the props used for rendering. If you create a react component, rather than a render-function, for use by React on Rails, then you get whatever props are passed in from the view helper, which **does not include the Rails Context**. It's trivial to wrap your component in a "render-function" to return a new component that takes both:
|
106
142
|
|
107
143
|
```js
|
108
144
|
import React from 'react';
|
109
145
|
import AppComponent from './AppComponent';
|
110
146
|
const AppComponentWithRailsContext = (props, railsContext) => (
|
111
|
-
|
147
|
+
// Create a React Function Component so you can
|
148
|
+
// use the React Hooks API in this React Function Component
|
149
|
+
() => <AppComponent {...{...props, railsContext}}/>
|
112
150
|
)
|
113
151
|
export default AppComponentWithRailsContext;
|
114
152
|
```
|
@@ -153,7 +191,7 @@ See [spec/dummy/config/initializers/react_on_rails.rb](https://github.com/shakac
|
|
153
191
|
module RenderingExtension
|
154
192
|
|
155
193
|
# Return a Hash that contains custom values from the view context that will get merged with
|
156
|
-
# the standard rails_context values and passed to all calls to
|
194
|
+
# the standard rails_context values and passed to all calls to render-functions used by the
|
157
195
|
# react_component and redux_store view helpers
|
158
196
|
def self.custom_context(view_context)
|
159
197
|
{
|
@@ -1,7 +1,32 @@
|
|
1
1
|
# RSpec Configuration
|
2
|
+
_Click [here for minitest](./minitest-configuration.md)_
|
3
|
+
|
4
|
+
# If your webpack configurations correspond to rails/webpacker's default setup
|
5
|
+
If you're able to configure your webpack configuration to be run by having your webpack configuration
|
6
|
+
returned by the files in `/config/webpack`, then you have 2 options to ensure that your files are
|
7
|
+
compiled by webpack before running tests and during production deployment:
|
8
|
+
|
9
|
+
1. **Use rails/webpacker's compile option**: Configure your `config/webpacker.yml` so that `compile: true` is for `test` and `production`
|
10
|
+
environments. Ensure that your `source_path` is correct, or else `rails/webpacker` won't correctly
|
11
|
+
detect changes.
|
12
|
+
2. **Use the react_on_rails settings and helpers**. Use the settings in `config/initializers/react_on_rails.rb`. Refer to [docs/configuration](./configuration.md).
|
13
|
+
|
14
|
+
```yml
|
15
|
+
config.build_production_command = "RAILS_ENV=production bin/webpack"
|
16
|
+
config.build_test_command = "RAILS_ENV=test bin/webpack"
|
17
|
+
```
|
18
|
+
|
19
|
+
Which should you use? If you're already using the `rails/webpacker` way to configure webpack, then
|
20
|
+
you can keep things simple and use the `rails/webpacker` options.
|
21
|
+
|
22
|
+
# Checking for stale assets using React on Rails
|
23
|
+
|
2
24
|
Because you will probably want to run RSpec tests that rely on compiled webpack assets (typically, your integration/feature specs where `js: true`), you will want to ensure you don't accidentally run tests on missing or stale webpack assets. If you did use stale Webpack assets, you will get invalid test results as your tests do not use the very latest JavaScript code.
|
3
25
|
|
4
|
-
|
26
|
+
As mentioned above, you can configure `compile: true` in `config/webpacker.yml` _if_ you've got configuration for
|
27
|
+
your webpack in the standard `rails/webpacker` spot of `config/webpack/<NODE_ENV>.js`
|
28
|
+
|
29
|
+
ReactOnRails also provides a helper method called `ReactOnRails::TestHelper.configure_rspec_to_compile_assets`. Call this method from inside of the `RSpec.configure` block in your `spec/rails_helper.rb` file, passing the config as an argument. See file [lib/react_on_rails/test_helper.rb](../../lib/react_on_rails/test_helper.rb) for more details. You can customize this to your particular needs by replacing any of the default components used by `ReactOnRails::TestHelper.configure_rspec_to_compile_assets`.
|
5
30
|
|
6
31
|
```ruby
|
7
32
|
RSpec.configure do |config|
|
@@ -24,38 +49,25 @@ Please take note of the following:
|
|
24
49
|
|
25
50
|
- This utility uses your `build_test_command` to build the static generated files. This command **must not** include the `--watch` option. If you have different server and client bundle files, this command **must** create all the bundles. If you are using webpacker, the default value will come from the `config/webpacker.yml` value for the `public_output_path` and the `source_path`
|
26
51
|
|
27
|
-
- If you add an older file to your source files, that is already older than the produced output files, no new recompilation is done. The solution to this issue is to clear out your directory of webpack generated files when adding new source files that may have older dates. This
|
52
|
+
- If you add an older file to your source files, that is already older than the produced output files, no new recompilation is done. The solution to this issue is to clear out your directory of webpack generated files when adding new source files that may have older dates. This can happen when you've built your test generated files and then you sync up your repository files.
|
28
53
|
|
29
|
-
- By default, the webpack processes look
|
54
|
+
- By default, the webpack processes look in the webpack generated files folder, configured via the `config/webpacker.yml` config values of `public_root_path` and `public_output_path`. If the webpack generated files folder is missing, is empty, or contains files in the `config.webpack_generated_files` list with `mtime`s older than any of the files in your `client` folder, the helper will recompile your assets.
|
30
55
|
|
31
56
|
The following `config/react_on_rails.rb` settings **must** match your setup:
|
32
57
|
```ruby
|
33
|
-
# Directory where your generated assets go. All generated assets must go to the same directory.
|
34
|
-
# Configure this in your webpack config files. This relative to your Rails root directory.
|
35
|
-
# We recommend having different generated assets dirs per Rails env.
|
36
|
-
config.generated_assets_dir = File.join(%w[public webpack], Rails.env)
|
37
|
-
|
38
58
|
# Define the files we need to check for webpack compilation when running tests.
|
39
|
-
# Generally, the manifest.json is good enough for this check if using webpacker
|
40
59
|
config.webpack_generated_files = %w( manifest.json )
|
41
60
|
|
42
61
|
# OR if you're not hashing the server-bundle.js, then you should include your server-bundle.js in the list.
|
43
62
|
# config.webpack_generated_files = %w( server-bundle.js manifest.json )
|
44
63
|
|
45
|
-
# OR if you're not using webpacker, your setup might look like.
|
46
|
-
# config.webpack_generated_files = %w( client-bundle.js server-bundle.js )
|
47
|
-
|
48
64
|
# If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
|
49
65
|
# with rspec then this controls what yarn command is run
|
50
66
|
# to automatically refresh your webpack assets on every test run.
|
51
67
|
config.build_test_command = "yarn run build:test"
|
52
68
|
```
|
53
69
|
|
54
|
-
If you want to speed up the re-compiling process so you don't wait to run your tests to build the files, you can run your test compilation with the "watch" flags.
|
55
|
-
|
56
|
-
[spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy) contains examples of how to set the proc files for this purpose.
|
57
|
-
|
58
|
-
If you want to use a testing framework other than RSpec, please submit let us know on the changes you need to do and we'll update the docs.
|
70
|
+
If you want to speed up the re-compiling process so you don't wait to run your tests to build the files, you can run your test compilation with the "watch" flags. For example, `yarn run build:test --watch`
|
59
71
|
|
60
72
|
![2016-01-27_02-36-43](https://cloud.githubusercontent.com/assets/1118459/12611951/7c56d070-c4a4-11e5-8a80-9615f99960d9.png)
|
61
73
|
|
@@ -5,12 +5,76 @@ If you would like help in migrating between React on Rails versions or help with
|
|
5
5
|
|
6
6
|
We specialize in helping companies to quickly and efficiently move from versions before 9 to current. The older versions use the Rails asset pipeline to package client assets. The current and recommended way is to use Webpack 4 for asset preparation. You may also need help migrating from the `rails/webpacker`'s Webpack configuration to a better setup ready for Server Side Rendering.
|
7
7
|
|
8
|
+
## Upgrading to v12
|
9
|
+
* Make sure that you are on a relatively more recent version of rails and webpacker.
|
10
|
+
* If the webpacker webpack config files exist, then React on Rails will not override the default
|
11
|
+
assets:precompile setup by rails/webpacker. The fix is to remove the JS files inside of config/webpack,
|
12
|
+
like config/webpack/production.js.
|
13
|
+
* If you're using the internalization helper, then set `config.i18n_output_format = 'js'`. You can
|
14
|
+
later update to the default JSON format as you will need to update your usage of that file.
|
15
|
+
|
16
|
+
* Updated API for ReactOnRails.register.
|
17
|
+
|
18
|
+
In order to solve the issues regarding React Hooks compatibility, the number of parameters
|
19
|
+
for functions is used to determine if you have a render function that will get invoked to
|
20
|
+
return a React component, or you are registering a React component defined by a function.
|
21
|
+
|
22
|
+
Registered Objects are of the following types:
|
23
|
+
|
24
|
+
##### Correct
|
25
|
+
Either of these will work:
|
26
|
+
1. Take **2 params** and return **a React function or class component**. A function component is a function
|
27
|
+
that takes zero or one params and returns a React Element, like JSX.
|
28
|
+
```js
|
29
|
+
export default (props, _railsContext) => () => <Component {...props} />;
|
30
|
+
```
|
31
|
+
|
32
|
+
2. Take only zero or one params and you return a React Element, often JSX.
|
33
|
+
```js
|
34
|
+
export default (props) => <Component {...props} />;
|
35
|
+
```
|
36
|
+
##### Broken, as this function takes two params and it returns a React Element from a JSX Literal
|
37
|
+
```js
|
38
|
+
export default (props, _railsContext) => <Component {...props} />;
|
39
|
+
```
|
40
|
+
|
41
|
+
If you make this mistake, you'll get this warning
|
42
|
+
`Warning: React.createElement: type is invalid -- expected a string (for built-in components) or a class/function (for composite components) but got: <Fragment />. Did you accidentally export a JSX literal instead of a component?`
|
43
|
+
|
44
|
+
And this error:
|
45
|
+
`react-dom.development.js:23965 Uncaught Error: Element type is invalid: expected a string (for built-in components) or a class/function (for composite components) but got: object.`
|
46
|
+
|
47
|
+
In this example, you need to wrap the `<Component {...props} />` in a function call like this which
|
48
|
+
results in the return value being a React function component.
|
49
|
+
|
50
|
+
```js
|
51
|
+
export default (props, _railsContext) => () => <Component {...props} />;
|
52
|
+
```
|
53
|
+
|
54
|
+
If you have a pure component, taking one or zero parameters, and you have an unnecessary function
|
55
|
+
wrapper such that you're returning a function rather than a React Element, then:
|
56
|
+
|
57
|
+
1. You won't see anything render.
|
58
|
+
2. You will see this warning in development mode: `Warning: Functions are not valid as a React child. This may happen if you return a Component instead of <Component /> from render. Or maybe you meant to call this function rather than return it.`
|
59
|
+
|
60
|
+
---------
|
61
|
+
|
62
|
+
## Upgrading rails/webpacker from v3 to v4
|
63
|
+
### Custom Webpack build file
|
64
|
+
The default value for `extract_css` is **false** in `config/webpack.yml`. Custom webpack builds should set this value to true or else no CSS link tags are generated. You have a custom webpack build if you are not using [rails/webpacker](https://github.com/rails/webpacker to setup your Webpack configuration.
|
65
|
+
|
66
|
+
```yml
|
67
|
+
default: &default
|
68
|
+
# other stuff
|
69
|
+
extract_css: true
|
70
|
+
# by default, extract and emit a css file. The default is false
|
71
|
+
```
|
72
|
+
|
8
73
|
## Upgrading to version 11
|
9
74
|
* Remove `server_render_method` from config/initializers/react_on_rails.rb. Alternate server rendering methods are part of React on Rails Pro. If you want to use a custom renderer, contact justin@shakacode.com. We have a custom node rendering solution in production for egghead.io.
|
10
75
|
* Remove your usage of ENV["TRACE_REACT_ON_RAILS"] usage. You can get all tracing with either specifying **`trace`** at your component or in your config/initializers/react_on_rails.rb file.
|
11
76
|
* ReactOnRails::Utils.server_bundle_file_name and ReactOnRails::Utils.bundle_file_name were removed. React on Rails Pro contains upgrades to enable component and other types caching with React on Rails.
|
12
77
|
|
13
|
-
|
14
78
|
## Upgrading to version 10
|
15
79
|
|
16
80
|
Pretty simple:
|
@@ -32,8 +96,8 @@ Reason for doing this: This enables your webpack bundles to bypass the Rails ass
|
|
32
96
|
##### ...while keeping your `client` directory
|
33
97
|
* `.gitignore`: add `/public/webpack/*`
|
34
98
|
* `Gemfile`: bump `react_on_rails` and add `webpacker`
|
35
|
-
* layout views: anything bundled by webpack will need to be requested by a `javascript_pack_tag` or `stylesheet_pack_tag`.
|
36
|
-
* Search your codebase for javascript_include_tag. Use the
|
99
|
+
* layout views: anything bundled by webpack will need to be requested by a `javascript_pack_tag` or `stylesheet_pack_tag`.
|
100
|
+
* Search your codebase for javascript_include_tag. Use the
|
37
101
|
* `config/initializers/assets.rb`: we no longer need to modify `Rails.application.config.assets.paths` or append anything to `Rails.application.config.assets.precompile`.
|
38
102
|
* `config/initializers/react_on_rails.rb`:
|
39
103
|
* Delete `config.generated_assets_dir`. Webpacker's config now supplies this information
|