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.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +320 -0
  3. data/.eslintignore +2 -1
  4. data/.eslintrc +23 -1
  5. data/.github/FUNDING.yml +1 -0
  6. data/.gitignore +3 -1
  7. data/.prettierignore +10 -1
  8. data/.prettierrc +3 -0
  9. data/.rubocop.yml +37 -11
  10. data/.travis.yml +10 -20
  11. data/CHANGELOG.md +85 -9
  12. data/CONTRIBUTING.md +60 -71
  13. data/Gemfile +3 -4
  14. data/{COMM-LICENSE → REACT-ON-RAILS-PRO-LICENSE} +6 -9
  15. data/README.md +121 -71
  16. data/Rakefile +0 -7
  17. data/SUMMARY.md +9 -12
  18. data/book.json +5 -5
  19. data/docs/additional-reading/asset-pipeline.md +8 -16
  20. data/docs/additional-reading/react-helmet.md +30 -10
  21. data/docs/additional-reading/react-router.md +52 -75
  22. data/docs/additional-reading/server-rendering-tips.md +12 -7
  23. data/docs/api/javascript-api.md +3 -3
  24. data/docs/api/redux-store-api.md +4 -2
  25. data/docs/api/view-helpers-api.md +8 -9
  26. data/docs/basics/configuration.md +68 -59
  27. data/docs/basics/deployment.md +1 -2
  28. data/docs/basics/hmr-and-hot-reloading-with-the-webpack-dev-server.md +49 -0
  29. data/docs/basics/i18n.md +44 -22
  30. data/docs/basics/installation-into-an-existing-rails-app.md +2 -2
  31. data/docs/basics/minitest-configuration.md +31 -0
  32. data/docs/basics/react-server-rendering.md +1 -1
  33. data/docs/basics/{generator-functions-and-railscontext.md → render-functions-and-railscontext.md} +59 -21
  34. data/docs/basics/rspec-configuration.md +29 -17
  35. data/docs/basics/upgrading-react-on-rails.md +67 -3
  36. data/docs/basics/webpack-configuration.md +15 -1
  37. data/docs/contributor-info/errors-with-hooks.md +45 -0
  38. data/docs/contributor-info/pull-requests.md +44 -0
  39. data/docs/misc/doctrine.md +1 -1
  40. data/docs/{misc-pending → outdated}/code-splitting.md +12 -8
  41. data/docs/{additional-reading → outdated}/heroku-deployment.md +0 -6
  42. data/docs/{basics → outdated}/how-react-on-rails-works.md +3 -3
  43. data/docs/{misc-pending → outdated}/manual-installation-overview.md +5 -5
  44. data/docs/{additional-reading → outdated}/rails-assets-relative-paths.md +3 -3
  45. data/docs/{misc-pending → outdated}/rails-assets.md +4 -7
  46. data/docs/{misc → outdated}/rails3.md +0 -0
  47. data/docs/testimonials/resortpass.md +13 -0
  48. data/docs/testimonials/testimonials.md +11 -1
  49. data/docs/tutorial.md +96 -70
  50. data/jest.config.js +4 -0
  51. data/lib/generators/react_on_rails/base_generator.rb +2 -2
  52. data/lib/generators/react_on_rails/dev_tests_generator.rb +1 -1
  53. data/lib/generators/react_on_rails/generator_helper.rb +4 -6
  54. data/lib/generators/react_on_rails/templates/base/base/Procfile.dev +3 -1
  55. data/lib/generators/react_on_rails/templates/base/base/Procfile.dev-hmr +26 -0
  56. data/lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.jsx +20 -40
  57. data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb +2 -1
  58. data/lib/generators/react_on_rails/templates/redux/base/app/javascript/bundles/HelloWorld/components/HelloWorld.jsx +4 -8
  59. data/lib/generators/react_on_rails/templates/redux/base/app/javascript/bundles/HelloWorld/store/helloWorldStore.js +1 -3
  60. data/lib/react_on_rails.rb +3 -1
  61. data/lib/react_on_rails/configuration.rb +13 -22
  62. data/lib/react_on_rails/error.rb +2 -0
  63. data/lib/react_on_rails/helper.rb +100 -143
  64. data/lib/react_on_rails/json_parse_error.rb +2 -0
  65. data/lib/react_on_rails/locales/base.rb +150 -0
  66. data/lib/react_on_rails/locales/to_js.rb +37 -0
  67. data/lib/react_on_rails/locales/to_json.rb +27 -0
  68. data/lib/react_on_rails/prerender_error.rb +11 -15
  69. data/lib/react_on_rails/react_component/render_options.rb +4 -0
  70. data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb +41 -46
  71. data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb +7 -8
  72. data/lib/react_on_rails/utils.rb +14 -19
  73. data/lib/react_on_rails/version.rb +1 -1
  74. data/lib/react_on_rails/version_checker.rb +1 -0
  75. data/lib/react_on_rails/webpacker_utils.rb +13 -2
  76. data/lib/tasks/assets.rake +19 -44
  77. data/lib/tasks/locale.rake +4 -2
  78. data/package-scripts.yml +11 -8
  79. data/package.json +29 -28
  80. data/rakelib/dummy_apps.rake +1 -9
  81. data/rakelib/example_type.rb +3 -1
  82. data/rakelib/examples.rake +3 -0
  83. data/rakelib/lint.rake +2 -7
  84. data/rakelib/node_package.rake +2 -2
  85. data/rakelib/release.rake +0 -6
  86. data/rakelib/run_rspec.rake +5 -18
  87. data/react_on_rails.gemspec +3 -5
  88. data/tsconfig.json +14 -0
  89. data/webpackConfigLoader.js +3 -2
  90. data/yarn.lock +4170 -2197
  91. metadata +34 -57
  92. data/Gemfile.rails32 +0 -73
  93. data/docs/additional-reading/babel.md +0 -5
  94. data/docs/additional-reading/hot-reloading-rails-development-asset-pipeline.md +0 -47
  95. data/docs/api/ruby-api-hot-reload-view-helpers.md +0 -44
  96. data/lib/generators/react_on_rails/templates/base/base/Procfile.dev-server +0 -12
  97. data/lib/react_on_rails/assets_precompile.rb +0 -153
  98. data/lib/react_on_rails/locales_to_js.rb +0 -138
@@ -3,11 +3,10 @@ sudo: required
3
3
  language: ruby
4
4
 
5
5
  rvm:
6
- # Rails 5 requires 2.2
7
- - 2.3.1
8
- - 2.4.1
9
- - 2.5.0
10
- - 2.2.6
6
+ - 2.5.3
7
+ - 2.6.5
8
+ - 2.7.0
9
+
11
10
  services:
12
11
  - docker
13
12
 
@@ -19,7 +18,6 @@ cache:
19
18
 
20
19
  gemfile:
21
20
  - spec/dummy/Gemfile
22
- - spec/dummy_no_webpacker/Gemfile.rails32
23
21
 
24
22
  env:
25
23
  global:
@@ -36,13 +34,16 @@ before_install:
36
34
  - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16"
37
35
 
38
36
  install:
39
- - travis_retry gem install bundler
40
- - travis_retry nvm install 8.11.3
37
+ - travis_retry gem install bundler -v '>2'
38
+ - travis_retry nvm install 13.9.0
41
39
  - node -v
42
40
  - travis_retry npm i -g yarn
43
41
  - travis_retry bundle install
42
+ - travis_retry yarn global add yalc
43
+ - travis_retry yalc publish
44
+ - travis_retry cd spec/dummy && yalc add react-on-rails
44
45
  - travis_retry yarn
45
- - travis_retry yarn run build
46
+ - travis_retry cd ../.. && yarn run build
46
47
  - bundle exec rake prepare_for_ci
47
48
 
48
49
  before_script:
@@ -51,17 +52,6 @@ before_script:
51
52
  script:
52
53
  - bundle exec rake
53
54
 
54
- matrix:
55
- exclude:
56
- - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
57
- rvm: 2.3.1
58
- - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
59
- rvm: 2.4.1
60
- - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
61
- rvm: 2.5.0
62
- - gemfile: spec/dummy/Gemfile
63
- rvm: 2.2.6
64
-
65
55
  notifications:
66
56
  slack:
67
57
  secure: LfcUk4AJ4vAxWwRIyw4tFh8QNbYefMwfG/oLfsN3CdRMWMOtCOHR1GGsRhAOlfVVJ/FvHqVqWj5gK7z7CaO5Uvl7rD3/zJ8QzExKx/iH9yWj55iIPuKLzwFNnBwRpFW/cqyU2lFPPRxGD50BUn3c+qybkuSqtKZ6qtTowwqlxLa5iyM3N95aZp7MEIKCP7cPcnHfLbJyP8wBpotp/rtw62eXM2HIRJJwgjcp+n+My7VFR9DnBXNFf6R91aZHM4U4cHHDbu15HFtH8honVrzK1JQdyqMNHga+j04dFuaS7z9Q369/hsELMOBp/227+Pz7ZRfWZFK4UASguOvyeX7RmGTRpTuWLm1XJeUzfsPZVROecaSVQBve+U7F12yKqilt97QlvRXn2EGyBILqvxtFNNR4S9kgAf72/6EFgiM1TKq7i9zy6lVOnagU2+7amq7UeopX1uoFsUfNKMR7YbgV1WjF0IK95UP0b0/7ZOJlPYgi5zzkQi129qAFWSMmxGk+ZpsttHh/tjJtvAh0A3mHq/zb5w4ub/MbSyZqeDUNgGj72QArOWUFSAStQT1ybsVLeDoKPgOvVq7OV1D64rpcHjBXcqOCit8tDZ+TqkFhcYJo2cITSaqE4zJXn+4F5s7So5O8CyfKYQq+kFJCooYGmfgTUckJpGl7eIvKmL4TN9Q=
@@ -4,7 +4,7 @@ All notable changes to this project's source code will be documented in this fil
4
4
  Migration instructions for the major updates can be found [here](docs/basics/upgrading-react-on-rails.md#upgrading-to-version-9.md). Some smaller migration information can be found here.
5
5
 
6
6
  ## Need Help Migrating?
7
- If you would like help in migrating between React on Rails versions or help with implementing server rendering, please contact [justin@shakacode.com](mailto:justin@shakacode.com) for information about our [ShakaCode Pro Support](https://www.shakacode.com/work/shakacode-pro-support.pdf).
7
+ If you would like help in migrating between React on Rails versions or help with implementing server rendering, please contact [justin@shakacode.com](mailto:justin@shakacode.com) for information about our [React on Rails Pro Support Options](https://www.shakacode.com/react-on-rails-pro).
8
8
 
9
9
  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.
10
10
 
@@ -16,21 +16,93 @@ Changes since last non-beta release.
16
16
 
17
17
  *Please add entries here for your pull requests that are not yet released.*
18
18
 
19
- ### [11.2.0] - 2018-10-25
19
+ ## UPCOMING 12.0 RELEASE
20
+
21
+ #### Improved
22
+ ### [12.0.0.pre.beta.2]
23
+ * Changed the precompile task to use the rails/webpacker one by default
24
+
25
+ ### [12.0.0.pre.beta.1]
26
+ * Updated generators to use React hooks
27
+
28
+ ### [12.0.0.pre.beta.0]
29
+ Gem version: 12.0.0.pre.beta.0 and npm version 12.0.0-beta.0 released! Please try this out!
30
+
31
+ #### BREAKING CHANGE
32
+ In order to solve the issues regarding React Hooks compatibility, the number of parameters
33
+ for functions is used to determine if you have a generator function that will get invoked to
34
+ return a React component, or you are registering a functional React component. Alternately, you can
35
+ set JavaScript property `renderFunction` on the function for which you want to return to be
36
+ invoked to return the React component. In that case, you won't need to pass any unused params.
37
+ [PR 1268](https://github.com/shakacode/react_on_rails/pull/1268) by [justin808](https://github.com/justin808)
38
+
39
+ See [docs/basics/upgrading-react-on-rails](./docs/basics/upgrading-react-on-rails.md#upgrading-to-v12)
40
+ for details.
41
+
42
+ * Requires the use of rails/webpacker helpers
43
+ * If the webpacker webpack config files exist, then React on Rails will not override the default
44
+ assets:precompile setup by rails/webpacker. The fix is to remove the JS files inside of config/webpack,
45
+ like config/webpack/production.js.
46
+ * Removed **env_javascript_include_tag** and **env_stylesheet_link_tag** as these are replaced by view helpers
47
+ from rails/webpacker
48
+ * Removal of support for old Rubies and Rails.
49
+ * Removal of config.symlink_non_digested_assets_regex as it's no longer needed with rails/webpacker.
50
+ If any business needs this, we can move the code to a separate gem.
51
+ * Added configuration option `same_bundle_for_client_and_server` with default `false` because
52
+
53
+ 1. Production applications would typically have a server bundle that differs from the client bundle
54
+ 2. This change only affects trying to use HMR with react_on_rails with rails/webpacker.
55
+
56
+ The previous behavior was to always go to the webpack-dev-server for the server bundle if the
57
+ webpack-dev-server was running _and_ the server bundle was found in the `manifest.json`.
58
+
59
+ If you are using the **same bundle for client and server rendering**, then set this configuration option
60
+ to `true`. By [justin808](https://github.com/shakacode/react_on_rails/pull/1240).
61
+
62
+ * Added support to export locales in JSON format. New option added `i18n_output_format` which allows to
63
+ specify locales format either `JSON` or `JS`. **`JSON` format is now the default.**
64
+
65
+ Use this config setting to get the old behavior: config.i18n_output_format = 'js'
66
+
67
+ [PR 1271](https://github.com/shakacode/react_on_rails/pull/1271) by [ashgaliyev](https://github.com/ashgaliyev).
68
+
69
+ #### Improved
70
+ - Added Typescript definitions to the Node package. By [justin808](https://github.com/justin808) and [judahmeek](https://github.com/judahmeek) in [PR 1287](https://github.com/shakacode/react_on_rails/pull/1287).
71
+ - Removed unnecessary restriction to keep the server bundle in the same directory with the client bundles. Rails/webpacker 4 has an advanced cleanup that will remove any files in the directory of other webpack files. Removing this restriction allows the server bundle to be created in a sibling directory. By [justin808](https://github.com/shakacode/react_on_rails/pull/1240).
72
+
73
+ ### [11.3.0] - 2019-05-24
74
+ #### Added
75
+ - Added method for retrieving any option from `render_options` [PR 1213](https://github.com/shakacode/react_on_rails/pull/1213)
76
+ by [ashgaliyev](https://github.com/ashgaliyev).
77
+
78
+ - html_options has an option for 'tag' to set the html tag name like this: `html_options: { tag: "span" }`.
79
+ [PR 1208](https://github.com/shakacode/react_on_rails/pull/1208) by [tahsin352](https://github.com/tahsin352).
80
+
81
+ ### [11.2.2] - 2018-12-24
82
+ #### Improved
83
+ - rails_context can more easily be called from controller methods. The mandatory param of server_side has been made optional.
84
+
85
+ ### [11.2.1] - 2018-12-06
86
+ ## MIGRATION for v11.2
87
+ - If using **React on Rails Pro**, upgrade react_on_rails_pro to a version >= 1.3.
88
+
20
89
  #### Improved
21
- - To support React v16, updated API for manually calling `ReactOnRails.render(name, props, domNodeId, hydrate)`. Added 3rd @param hydrate Pass truthy to update server rendered html. Default is falsey Any truthy values calls hydrate rather than render. (https://github.com/shakacode/react_on_rails/pull/1159) by [justin808](https://github.com/justin808) and [coopersamuel](https://github.com/coopersamuel).
90
+ - To support React v16, updated API for manually calling `ReactOnRails.render(name, props, domNodeId, hydrate)`. Added 3rd @param hydrate Pass truthy to update server rendered html. Default is falsey Any truthy values calls hydrate rather than render. [PR 1159](https://github.com/shakacode/react_on_rails/pull/1159) by [justin808](https://github.com/justin808) and [coopersamuel](https://github.com/coopersamuel).
22
91
 
23
- - Enabled the use of webpack-dev-server with Server-side rendering. (https://github.com/shakacode/react_on_rails/pull/1173) by [justin808](https://github.com/justin808) and [judahmeek](https://github.com/judahmeek).
92
+ - Enabled the use of webpack-dev-server with Server-side rendering. [PR 1173](https://github.com/shakacode/react_on_rails/pull/1173) by [justin808](https://github.com/justin808) and [judahmeek](https://github.com/judahmeek).
24
93
 
25
94
  #### Changed
26
95
  - Changed the default for:
27
96
  ```rb
28
- config.raise_on_prerender_error = Rails.env.development?
97
+ config.raise_on_prerender_error = Rails.env.development?
29
98
  ```
30
-
99
+
31
100
  Thus, developers will need to fix server rendering errors before continuing.
32
101
  [PR 1145](https://github.com/shakacode/react_on_rails/pull/1145) by [justin808](https://github.com/justin808).
33
-
102
+
103
+ ### 11.2.0 - 2018-12-06
104
+ Do not use. Unpublished. Caused by an issue with the release script.
105
+
34
106
  ### [11.1.8] - 2018-10-14
35
107
 
36
108
  #### Improved
@@ -854,8 +926,12 @@ Best done with Object destructing:
854
926
  ##### Fixed
855
927
  - Fix several generator related issues.
856
928
 
857
- [Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.2.0...master
858
- [11.2.0]: https://github.com/shakacode/react_on_rails/compare/11.1.8...11.2.0
929
+ [Unreleased]: https://github.com/shakacode/react_on_rails/compare/12.0.0-beta.1...master
930
+ [12.0.0.pre.beta.1]: https://github.com/shakacode/react_on_rails/compare/12.0.0-beta.0...12.0.0-beta.1
931
+ [12.0.0.pre.beta.0]: https://github.com/shakacode/react_on_rails/compare/11.3.0...12.0.0-beta.0
932
+ [11.3.0]: https://github.com/shakacode/react_on_rails/compare/11.2.2...11.3.0
933
+ [11.2.2]: https://github.com/shakacode/react_on_rails/compare/11.2.1...11.2.2
934
+ [11.2.1]: https://github.com/shakacode/react_on_rails/compare/11.1.8...11.2.1
859
935
  [11.1.8]: https://github.com/shakacode/react_on_rails/compare/11.1.7...11.1.8
860
936
  [11.1.7]: https://github.com/shakacode/react_on_rails/compare/11.1.6...11.1.7
861
937
  [11.1.6]: https://github.com/shakacode/react_on_rails/compare/11.1.5...11.1.6
@@ -1,46 +1,9 @@
1
1
  # Tips for Contributors
2
2
 
3
- * See [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
3
+ * [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
4
+ * [docs/contributor-info/pull-requests](./docs/contributor-info/pull-requests.md)
4
5
  * See other docs in [docs/contributor-info](./docs/contributor-info)
5
6
 
6
- ## Summary
7
-
8
- For non-doc fixes:
9
-
10
- * Provide changelog entry in the [unreleased section of the CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#unreleased).
11
- * Ensure CI passes and that you added a test that passes with the fix and fails without the fix.
12
- * Squash all commits down to one with a nice commit message *ONLY* once final review is given. Make sure this single commit is rebased on top of master.
13
- * Please address all code review comments.
14
- * Ensure that docs are updated accordingly if a feature is added.
15
-
16
- ## Commit Messages
17
-
18
- From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
19
-
20
- #### The seven rules of a great git commit message
21
- > Keep in mind: This has all been said before.
22
-
23
- 1. Separate subject from body with a blank line
24
- 1. Limit the subject line to 50 characters
25
- 1. Capitalize the subject line
26
- 1. Do not end the subject line with a period
27
- 1. Use the imperative mood in the subject line
28
- 1. Wrap the body at 72 characters
29
- 1. Use the body to explain what and why vs. how
30
-
31
-
32
- ## Doc Changes
33
-
34
- When making doc changes, we want the change to work on both the gitbook and the regular github site. The issue is that non-doc files will not go to the gitbook site, so doc references to non doc files must use the github URL.
35
-
36
- ### Links to other docs:
37
- * When making references to doc files, use a relative URL path like:
38
- `[Installation Overview](docs/basics/installation-overview.md)`
39
-
40
- * When making references to source code files, use a full url path like:
41
- `[spec/dummy/config/initializers/react_on_rails.rb](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/config/initializers/react_on_rails.rb)`
42
-
43
-
44
7
  ## To run tests:
45
8
  * After updating code via git, to prepare all examples and run all tests:
46
9
 
@@ -91,52 +54,63 @@ gem "react_on_rails", path: "../path-to-react-on-rails"
91
54
 
92
55
  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**.
93
56
 
94
- ## Testing the Node package for react-on-rails
57
+ ## Testing the Node package for react-on-rails via Yalc
95
58
  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:
96
59
 
97
60
  ```sh
98
61
  cd react_on_rails/
99
62
  yarn
100
- yarn run build
101
- yarn install-react-on-rails
63
+
64
+ # Update the lib directory with babel compiled files
65
+ yarn run build:watch
102
66
  ```
67
+
68
+ You need to do this once:
103
69
 
104
- Install the local package by using yarn link, like this:
105
- ```sh
70
+ ```
71
+ # Will send the updates to other folders
72
+ yalc publish
73
+ cd spec/dummy
74
+ yalc add react-on-rails
75
+ ```
76
+
77
+ The workflow is:
78
+ 1. Make changes to the node package.
79
+ 2. We need yalc to push and then run yarn:
80
+ ```
81
+ cd <top dir>
82
+ # Will send the updates to other folders
83
+ yalc push
106
84
  cd spec/dummy
85
+
86
+ # Will update from yalc
107
87
  yarn
108
88
  ```
109
89
 
110
- Note, yarn will run the `postinstall` script of `spec/dummy/client` which runs `yarn link` to setup a sym link to the parent package.
90
+ When you run `yalc push`, you'll get an informative message
111
91
 
112
- #### Example: Testing NPM changes with the dummy app
113
- 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.
114
- 2. 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.
92
+ ```
93
+ yalc push
94
+ react-on-rails@12.0.0-12070fd1 published in store.
95
+ Pushing react-on-rails@12.0.0 in /Users/justin/shakacode/react-on-rails/react_on_rails/spec/dummy
96
+ Package react-on-rails@12.0.0-12070fd1 added ==> /Users/justin/shakacode/react-on-rails/react_on_rails/spec/dummy/node_modules/react-on-rails.
97
+ Don't forget you may need to run yarn after adding packages with yalc to install/update dependencies/bin scripts.
98
+ ```
115
99
 
116
- _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](https://github.com/yarnpkg/yarn/issues/2649) (above) is resolved._
100
+ #### Example: Testing NPM changes with the dummy app
101
+ 1. Add `console.log('Hello!')` to [clientStartup.ts, function render](https://github.com/shakacode/react_on_rails/blob/master/node_package/src/clientStartup.ts in `/node_package/src/clientStartup.js` to confirm we're getting an update to the node package client side. Do the same for function `serverRenderReactComponent` in `/node_package/src/serverRenderReactComponent.ts`.
102
+ 2. 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. If you did not see that message, then review the steps above for the workflow of making changes and pushing them via yalc.
117
103
 
118
104
  # Development Setup for Gem and Node Package Contributors
119
105
 
120
- ## Checklist before Committing
121
- 1. `rake`: runs all linters and specs (you need Docker setup, see below)
122
- 2. Did you need any more tests for your change?
123
- 3. Did you document your change? Update the README.md?
124
-
125
106
  ## Dev Initial Setup
126
107
 
127
108
  ### Prereqs
128
109
  After checking out the repo, making sure you have rvm and nvm setup (setup ruby and node), cd to `spec/dummy` and run `bin/setup` to install ruby dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
129
110
 
130
111
  ### Local Node Package
131
- 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)
132
-
133
- ```sh
134
- cd react_on_rails/spec/dummy
135
- yarn run install-react-on-rails
136
- ```
137
- _Note: this runs npm under the hood as explained in **Test NPM for react-on-rails** section above_
138
112
 
139
- 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:gen_all` rake task.
113
+ Note, 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:gen_all` rake task.
140
114
 
141
115
  *Side note: It's critical to use the alias section of the webpack config to avoid a double inclusion error. This has already been done for you in the example and dummy apps, but for reference:*
142
116
 
@@ -182,13 +156,6 @@ cd react_on_rails/spec/dummy
182
156
  rspec
183
157
  ```
184
158
 
185
- Eventually, we may have JS tests:
186
-
187
- ```sh
188
- cd react_on_rails/spec/dummy/client
189
- yarn run test
190
- ```
191
-
192
159
  ### Run most tests and linting
193
160
 
194
161
  ```sh
@@ -197,7 +164,7 @@ yarn run check
197
164
  ```
198
165
 
199
166
  ### Starting the Dummy App
200
- 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.
167
+ To run the dummy app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start` with one of the Procfiles. 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.
201
168
 
202
169
  ### RSpec Testing
203
170
  Run `rake` for testing the gem and `spec/dummy`. Otherwise, the `rspec` command only works for testing within the sample apps, like `spec/dummy`.
@@ -219,10 +186,26 @@ In your Rails app add this gem with a path to your fork.
219
186
 
220
187
  ```ruby
221
188
  gem 'react_on_rails', path: '../relative/path/to/react_on_rails'
222
- ```
189
+ ```
190
+
191
+ Then run `bundle`.
223
192
 
224
193
  The main installer can be run with ```rails generate react_on_rails:install```
225
194
 
195
+ Then use yalc to add the npm module.
196
+
197
+ Be sure that your ran this first at the top level of React on Rails
198
+
199
+ ```
200
+ yalc publish
201
+ ```
202
+
203
+ Then add the node package to your test app:
204
+
205
+ ```
206
+ yalc add react-on-rails
207
+ ```
208
+
226
209
  ### Testing the Generator
227
210
  The generators are covered by generator tests using Rails's generator testing helpers, but it never hurts to do a sanity check and explore the API. See [generator_testing_script.md](generator_testing_script.md) for a script on how to run the generator on a fresh project.
228
211
 
@@ -247,6 +230,12 @@ You can run specific linting for directories or files by using `docker-compose r
247
230
 
248
231
  `docker-compose run lint bash` sets you up to run from the container command line.
249
232
 
233
+ ### Updating Rubocop
234
+ 2 files require updating to update the Rubocop version:
235
+
236
+ 1. `react_on_rails.gemspec`
237
+ 2. `spec/dummy/Gemfile`
238
+
250
239
  ### Docker CI - Test and Linting
251
240
  Docker CI and Tests containers have a xvfd server automatically started for headless browser testing with selenium and Firefox.
252
241
 
data/Gemfile CHANGED
@@ -15,14 +15,14 @@ gem "jbuilder"
15
15
  gem "jquery-rails"
16
16
  gem "mini_racer"
17
17
  gem "puma"
18
-
19
18
  gem "rails_12factor"
20
19
  gem "ruby-lint", require: false
21
20
  gem "sass-rails"
22
21
  gem "scss_lint", require: false
23
22
  gem "sdoc", group: :doc
24
23
  gem "spring"
25
- gem "sqlite3"
24
+ gem "sprockets", "~>3.0"
25
+ gem "sqlite3", "~> 1.3.6"
26
26
  gem "turbolinks"
27
27
  gem "uglifier"
28
28
  gem "web-console", group: :development
@@ -30,12 +30,11 @@ gem "web-console", group: :development
30
30
  # below are copied from spec/dummy/Gemfile
31
31
  gem "capybara"
32
32
  gem "capybara-screenshot"
33
- gem "chromedriver-helper"
34
33
  gem "launchy"
35
34
  gem "rspec-rails"
36
35
  gem "rspec-retry"
37
36
  gem "selenium-webdriver"
38
- gem "webpacker"
37
+ gem "webpacker", ">= 4.0.0"
39
38
 
40
39
  gem "equivalent-xml", github: "mbklein/equivalent-xml"
41
40
  gem "rainbow"
@@ -1,6 +1,7 @@
1
+ React on Rails Pro License
1
2
  For React on Rails Pro, not the open source version. For open source, see https://github.com/shakacode/react_on_rails/blob/master/LICENSE.md.
2
3
 
3
- Copyright (c) 2018 Justin Gordon and ShakaCode, http://www.shakacode.com
4
+ Copyright (c) 2018, 2019 Justin Gordon and ShakaCode, http://www.shakacode.com
4
5
 
5
6
  All rights reserved.
6
7
 
@@ -19,7 +20,7 @@ In order to use the Software under this Agreement, you must receive a “Source
19
20
 
20
21
  1.1 General Use. This Agreement grants you a non-exclusive, non-transferable, limited license to the use rights for the Software, without the right to grant sublicenses, subject to the terms and conditions in this Agreement. The Software is licensed, not sold.
21
22
 
22
- 1.2 Unlimited Organization License. If you purchased an Organization License (included with the React on Rails Pro Software), you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
23
+ 1.2 Unlimited Organization License. You may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
23
24
 
24
25
  1.3 Archive Copies. You are entitled to make a reasonable amount of copies of the Software for archival purposes. Each copy must reproduce all copyright and other proprietary rights notices on or in the Software Product.
25
26
 
@@ -33,15 +34,11 @@ In order to use the Software under this Agreement, you must receive a “Source
33
34
 
34
35
  3.2 UNDER NO CIRCUMSTANCES MAY YOU USE THE SOFTWARE AS PART OF A PRODUCT OR SERVICE THAT PROVIDES SIMILAR FUNCTIONALITY TO THE SOFTWARE ITSELF.
35
36
 
36
- The Open Source version of the Software (“LGPL Version”) is licensed
37
- under the terms of the GNU Lesser General Public License versions 3.0
38
- (“LGPL”) and not under this EULA.
39
-
40
37
  4. Ownership. Notwithstanding anything to the contrary contained herein, except for the limited license rights expressly provided herein, ShakaCode and its suppliers have and will retain all rights, title and interest (including, without limitation, all patent, copyright, trademark, trade secret and other intellectual property rights) in and to the Software and all copies, modifications and derivative works thereof (including any changes which incorporate any of your ideas, feedback or suggestions). You acknowledge that you are obtaining only a limited license right to the Software, and that irrespective of any use of the words “purchase”, “sale” or like terms hereunder no ownership rights are being conveyed to you under this Agreement or otherwise.
41
38
 
42
39
  5. Fees and Payment. The Software license fees will be due and payable in full as set forth in the applicable invoice or at the time of purchase. If the Software does not function properly within two weeks of purchase, please contact us within those two weeks for a refund. You shall be responsible for all taxes, withholdings, duties and levies arising from the order (excluding taxes based on the net income of ShakaCode).
43
40
 
44
- 6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth on the React on Rails Pro support page (https://github.com/shakacode/react_on_rails/wiki/Commercial-Support), support and maintenance services may be included with the purchase of your license subscription.
41
+ 6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth in the attached Master Service Agreement included with the purchase of your license subscription.
45
42
 
46
43
  7. Term of Agreement.
47
44
 
@@ -52,6 +49,7 @@ under the terms of the GNU Lesser General Public License versions 3.0
52
49
  7.3 Expiration of License. Upon the expiration of any term under this Agreement, (a) all Software updates and services pursuant to the license shall cease, (b) you may only continue to run existing installations of the Software, (c) you may not install the Software on any additional Hosts, and (d) any new installation of the Software shall require the purchase of a new license subscription from ShakaCode.
53
50
 
54
51
  8. Disclaimer of Warranties. The Software is provided "as is," with all faults, defects and errors, and without warranty of any kind. ShakaCode does not warrant that the Software will be free of bugs, errors, viruses or other defects, and ShakaCode shall have no liability of any kind for the use of or inability to use the Software, the Software content or any associated service, and you acknowledge that it is not technically practicable for ShakaCode to do so.
52
+
55
53
  To the maximum extent permitted by applicable law, ShakaCode disclaims all warranties, express, implied, arising by law or otherwise, regarding the Software, the Software content and their respective performance or suitability for your intended use, including without limitation any implied warranty of merchantability, fitness for a particular purpose.
56
54
 
57
55
  9. Limitation of Liability.
@@ -72,12 +70,11 @@ In no event will ShakaCode's liability exceed the Software license price as indi
72
70
 
73
71
  12. Third Party Software. Examples included in Software may provide links to third party libraries or code (collectively “Third Party Software”) to implement various functions. Third Party Software does not comprise part of the Software. In some cases, access to Third Party Software may be included along with the Software delivery as a convenience for demonstration purposes. Such source code and libraries may be included in the “…/examples” source tree delivered with the Software and do not comprise the Software. Licensee acknowledges (1) that some part of Third Party Software may require additional licensing of copyright and patents from the owners of such, and (2) that distribution of any of the Software referencing or including any portion of a Third Party Software may require appropriate licensing from such third parties.
74
72
 
75
-
76
73
  13. Miscellaneous
77
74
 
78
75
  13.1 Entire Agreement. This Agreement sets forth our entire agreement with respect to the Software and the subject matter hereof and supersedes all prior and contemporaneous understandings and agreements whether written or oral.
79
76
 
80
- 13.2 Amendment. ShakaCode reserves the right, in its sole discretion, to amend this Agreement from time. Amendments to this Agreement can be located at: https://github.com/shakacode/react_on_rails/blob/master/COMM-LICENSE.
77
+ 13.2 Amendment. ShakaCode reserves the right, in its sole discretion, to amend this Agreement from time. Amendments to this Agreement can be located at: https://github.com/shakacode/react_on_rails/blob/master/REACT-ON-RAILS-PRO-LICENSE.
81
78
 
82
79
  13.3 Assignment. You may not assign this Agreement or any of its rights under this Agreement without the prior written consent of ShakaCode and any attempted assignment without such consent shall be void.
83
80