react_on_rails 11.1.7 → 12.0.0.pre.beta.0

data/.release-it.json

@@ -0,0 +1,3 @@
+{
+  "requireCleanWorkingDir": false
+}

data/.rubocop.yml

@@ -3,7 +3,7 @@
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.5
 
   Include:
     - '**/Rakefile'
@@ -27,12 +27,8 @@ AllCops:
     - 'spec/react_on_rails/dummy-for-generators/**/*'
     - 'spec/dummy/Procfile.*'
     - 'spec/dummy/bin/**/*'
-    - 'spec/dummy/client/node_modules/**/*'
-    - 'spec/dummy/client/node_modules/**/.*'
-    - 'spec/dummy_no_webpacker/Procfile.*'
-    - 'spec/dummy_no_webpacker/bin/**/*'
-    - 'spec/dummy_no_webpacker/client/node_modules/**/*'
-    - 'spec/dummy_no_webpacker/client/node_modules/**/.*'
+    - 'spec/dummy/node_modules/**/*'
+    - 'spec/dummy/node_modules/**/.*'
     - 'gen-examples/examples/**/.*'
     - 'gen-examples/examples/**/*'
 
@@ -40,13 +36,12 @@ Naming/FileName:
   Exclude:
     - 'Gemfile'
     - 'spec/dummy/Gemfile'
-    - 'spec/dummy_no_webpacker/Gemfile'
 
 # Turn off until we require 2.3 ruby
 Style/SafeNavigation:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Style/StringLiterals:
@@ -55,11 +50,20 @@ Style/StringLiterals:
 Style/Documentation:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Lint/AssignmentInCondition:
   Exclude:
     - 'spec/dummy/bin/spring'
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Exclude:
     - 'spec/dummy/bin/rails'
     - 'spec/dummy/bin/rake'
@@ -86,9 +90,31 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Max: 180
 
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
 Style/GlobalVars:
   Exclude:
     - 'spec/dummy/config/environments/development.rb'
 
 Style/FrozenStringLiteralComment:
-  EnforcedStyle: when_needed
+  EnforcedStyle: always
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+

data/.travis.yml

@@ -3,11 +3,10 @@ sudo: required
 language: ruby
 
 rvm:
-  # Rails 5 requires 2.2
-  - 2.3.1
-  - 2.4.1
-  - 2.5.0
-  - 2.2.6
+  - 2.5.3
+  - 2.6.5
+  - 2.7.0
+
 services:
   - docker
 
@@ -19,7 +18,6 @@ cache:
 
 gemfile:
   - spec/dummy/Gemfile
-  - spec/dummy_no_webpacker/Gemfile.rails32
 
 env:
   global:
@@ -36,13 +34,16 @@ before_install:
   - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16"
 
 install:
-  - travis_retry gem install bundler
-  - travis_retry nvm install 8.11.3
+  - travis_retry gem install bundler -v '>2'
+  - travis_retry nvm install 13.9.0
   - node -v
   - travis_retry npm i -g yarn
   - travis_retry bundle install
+  - travis_retry yarn global add yalc
+  - travis_retry yalc publish
+  - travis_retry cd spec/dummy && yalc add react-on-rails
   - travis_retry yarn
-  - travis_retry yarn run build
+  - travis_retry cd ../.. && yarn run build
   - bundle exec rake prepare_for_ci
 
 before_script:
@@ -51,17 +52,6 @@ before_script:
 script:
   - bundle exec rake
 
-matrix:
-  exclude:
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.3.1
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.4.1
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.5.0
-    - gemfile: spec/dummy/Gemfile
-      rvm: 2.2.6
-
 notifications:
   slack:
     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=

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project's source code will be documented in this file. Items under `Unreleased` is upcoming features that will be out in next version. NOTE: major versions of the npm module and the gem must be kept in sync.
 
-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. 
+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.
 
 ## Need Help Migrating?
 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).
@@ -16,6 +16,85 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
+## UPCOMING 12.0 RELEASE
+### [12.0.0]
+#### BREAKING CHANGE
+In order to solve the issues regarding React Hooks compatibility, the number of parameters
+for functions is used to determine if you have a generator function that will get invoked to
+return a React component, or you are registering a functional React component. Alternately, you can
+set JavaScript property `renderFunction` on the function for which you want to return to be
+invoked to return the React component. In that case, you won't need to pass any unused params.
+[PR 1268](https://github.com/shakacode/react_on_rails/pull/1268) by [justin808](https://github.com/justin808)
+
+See [docs/basics/upgrading-react-on-rails](./docs/basics/upgrading-react-on-rails#upgrading-to-v12)
+for details.         
+
+* Requires the use of rails/webpacker helpers
+* Removed **env_javascript_include_tag** and **env_stylesheet_link_tag** as these are replaced by view helpers
+  from rails/webpacker
+* Removal of support for old Rubies and Rails.
+* Removal of config.symlink_non_digested_assets_regex as it's no longer needed with rails/webpacker.
+  If any business needs this, we can move the code to a separate gem.
+* Added configuration option `same_bundle_for_client_and_server` with default `false` because
+
+  1. Production applications would typically have a server bundle that differs from the client bundle
+  2. This change only affects trying to use HMR with react_on_rails with rails/webpacker. 
+  
+  The previous behavior was to always go to the webpack-dev-server for the server bundle if the 
+  webpack-dev-server was running _and_ the server bundle was found in the `manifest.json`. 
+  
+  If you are using the **same bundle for client and server rendering**, then set this configuration option
+  to `true`. By [justin808](https://github.com/shakacode/react_on_rails/pull/1240).
+  
+* Added support to export locales in JSON format. New option added `i18n_output_format` which allows to
+  specify locales format either `JSON` or `JS`. **`JSON` format is now the default.**
+ 
+  Use this config setting to get the old behavior: config.i18n_output_format = 'js'
+  
+  [PR 1271](https://github.com/shakacode/react_on_rails/pull/1271) by [ashgaliyev](https://github.com/ashgaliyev).
+
+#### Improved
+- 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).
+- 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).
+
+### [11.3.0] - 2019-05-24
+#### Added
+- Added method for retrieving any option from `render_options` [PR 1213](https://github.com/shakacode/react_on_rails/pull/1213)
+by [ashgaliyev](https://github.com/ashgaliyev).
+
+- html_options has an option for 'tag' to set the html tag name like this: `html_options: { tag: "span" }`.
+[PR 1208](https://github.com/shakacode/react_on_rails/pull/1208) by [tahsin352](https://github.com/tahsin352).
+
+### [11.2.2] - 2018-12-24
+#### Improved
+- rails_context can more easily be called from controller methods. The mandatory param of server_side has been made optional.
+
+### [11.2.1] - 2018-12-06
+## MIGRATION for v11.2
+- If using **React on Rails Pro**, upgrade react_on_rails_pro to a version >= 1.3.
+
+#### Improved
+- 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).
+
+- 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).
+
+#### Changed
+- Changed the default for:
+  ```rb
+  config.raise_on_prerender_error = Rails.env.development?
+  ```
+
+  Thus, developers will need to fix server rendering errors before continuing.
+  [PR 1145](https://github.com/shakacode/react_on_rails/pull/1145) by [justin808](https://github.com/justin808).
+
+### 11.2.0 - 2018-12-06
+Do not use. Unpublished. Caused by an issue with the release script.
+
+### [11.1.8] - 2018-10-14
+
+#### Improved
+- Improved tutorial and support for HMR when using `rails/webpacker` for Webpack configuration. [PR 1156](https://github.com/shakacode/react_on_rails/pull/1156) by [justin808](https://github.com/justin808).
+
 ### [11.1.7] - 2018-10-10
 #### Fixed
 - Fixed bug where intl parsing would fail when trying to parse integers or blank entries. by [sepehr500](https://github.com/sepehr500)
@@ -45,7 +124,7 @@ Changes since last non-beta release.
 
 #### Fixed
 - Tests now properly exit if the config.build_test_command fails!
-- Source path for project using Webpacker would default to "app/javascript" even if when the node_modules 
+- Source path for project using Webpacker would default to "app/javascript" even if when the node_modules
   directory was set to "client". Fix now makes the configuration of this crystal clear.
 - renamed method RenderOptions.has_random_dom_id? to RenderOptions.random_dom_id? for rubocop rule.
 [PR 1133](https://github.com/shakacode/react_on_rails/pull/1133) by [justin808](https://github.com/justin808)
@@ -834,7 +913,11 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.1.7...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.3.0...master
+[11.3.0]: https://github.com/shakacode/react_on_rails/compare/11.2.2...11.3.0
+[11.2.2]: https://github.com/shakacode/react_on_rails/compare/11.2.1...11.2.2
+[11.2.1]: https://github.com/shakacode/react_on_rails/compare/11.1.8...11.2.1
+[11.1.8]: https://github.com/shakacode/react_on_rails/compare/11.1.7...11.1.8
 [11.1.7]: https://github.com/shakacode/react_on_rails/compare/11.1.6...11.1.7
 [11.1.6]: https://github.com/shakacode/react_on_rails/compare/11.1.5...11.1.6
 [11.1.5]: https://github.com/shakacode/react_on_rails/compare/11.1.4...11.1.5

data/CONTRIBUTING.md

@@ -1,46 +1,9 @@
 # Tips for Contributors
 
-* See [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
+* [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
+* [docs/contributor-info/pull-requests](./docs/contributor-info/pull-requests.md)
 * See other docs in [docs/contributor-info](./docs/contributor-info)
 
-## Summary
-
-For non-doc fixes:
-
-* Provide changelog entry in the [unreleased section of the CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#unreleased).
-* Ensure CI passes and that you added a test that passes with the fix and fails without the fix.
-* 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.
-* Please address all code review comments.
-* Ensure that docs are updated accordingly if a feature is added.
-
-## Commit Messages
-
-From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
-
-#### The seven rules of a great git commit message
-> Keep in mind: This has all been said before.
-
-1. Separate subject from body with a blank line
-1. Limit the subject line to 50 characters
-1. Capitalize the subject line
-1. Do not end the subject line with a period
-1. Use the imperative mood in the subject line
-1. Wrap the body at 72 characters
-1. Use the body to explain what and why vs. how
-
-
-## Doc Changes
-
-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.
-
-### Links to other docs:
-* When making references to doc files, use a relative URL path like:
-`[Installation Overview](docs/basics/installation-overview.md)`
-
-* When making references to source code files, use a full url path like:
-`[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)`
-
-
 ## To run tests:
 * After updating code via git, to prepare all examples and run all tests:
 
@@ -91,60 +54,63 @@ gem "react_on_rails", path: "../path-to-react-on-rails"
 
 Note that you will need to bundle install after making this change, but also that **you will need to restart your Rails application if you make any changes to the gem**.
 
-## Testing the Node package for react-on-rails
+## Testing the Node package for react-on-rails via Yalc
 In addition to testing the Ruby parts out, you can also test the node package parts of the gem with an external application. First, be **sure** to build the NPM package:
 
 ```sh
 cd react_on_rails/
 yarn
-yarn run build
-yarn install-react-on-rails
+
+# Update the lib directory with babel compiled files
+yarn run build:watch
 ```
+   
+You need to do this once:
 
-Install the local package by using yarn link, like this:
-```sh
+```
+# Will send the updates to other folders
+yalc publish
+cd spec/dummy
+yalc add react-on-rails
+```
+
+The workflow is:
+1. Make changes to the node package.
+2. We need yalc to push and then run yarn:
+```
+cd <top dir>
+# Will send the updates to other folders
+yalc push
 cd spec/dummy
+
+# Will update from yalc
 yarn
 ```
 
-Note, yarn will run the `postinstall` script of `spec/dummy/client` which runs `yarn link` to setup a sym link to the parent package.
+When you run `yalc push`, you'll get an informative message
 
-#### Example: Testing NPM changes with the dummy app
-1. Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails/blob/master/node_package/src/clientStartup.js#L181) in `react_on_rails/node_package/src/clientStartup.js` to confirm we're getting an update to the node package.
-2. 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.
+```
+✗ yalc push
+react-on-rails@12.0.0-12070fd1 published in store.
+Pushing react-on-rails@12.0.0 in /Users/justin/shakacode/react-on-rails/react_on_rails/spec/dummy
+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.
+Don't forget you may need to run yarn after adding packages with yalc to install/update dependencies/bin scripts.
+```
 
-_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._
+#### Example: Testing NPM changes with the dummy app
+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`.
+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.
 
 # Development Setup for Gem and Node Package Contributors
 
-## Checklist before Committing
-1. `rake`: runs all linters and specs (you need Docker setup, see below)
-2. Did you need any more tests for your change?
-3. Did you document your change? Update the README.md?
-
 ## Dev Initial Setup
 
 ### Prereqs
 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.
 
-Additionally, our RSpec tests use the poltergeist web driver. You will need to install the phantomjs node module:
-
-```sh
-yarn global add phantomjs-prebuilt
-```
-
-Note this *must* be installed globally for the dummy test project rspec runner to see it properly.
-
 ### Local Node Package
-Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the dummy app's root directory and run this command below which runs something like [this script](spec/dummy/package.json#L14)
 
-```sh
-cd react_on_rails/spec/dummy
-yarn run install-react-on-rails
-```
-_Note: this runs npm under the hood as explained in **Test NPM for react-on-rails** section above_
-
-From now on, the example and dummy apps will use your local node_package folder as the react-on-rails node package. This will also be done automatically for you via the `rake examples:gen_all` rake task.
+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.
 
 *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:*
 
@@ -171,7 +137,7 @@ spec/dummy.
 
 ```sh
 # Optionally change default selenium_firefox driver
-export DRIVER=poltergeist
+export DRIVER=selenium_firefox
 cd react_on_rails/
 yarn run dummy:spec
 ```
@@ -190,13 +156,6 @@ cd react_on_rails/spec/dummy
 rspec
 ```
 
-Eventually, we may have JS tests:
-
-```sh
-cd react_on_rails/spec/dummy/client
-yarn run test
-```
-
 ### Run most tests and linting
 
 ```sh
@@ -205,7 +164,7 @@ yarn run check
 ```
 
 ### Starting the Dummy App
-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.
+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.
 
 ### RSpec Testing
 Run `rake` for testing the gem and `spec/dummy`. Otherwise, the `rspec` command only works for testing within the sample apps, like `spec/dummy`.
@@ -227,10 +186,26 @@ In your Rails app add this gem with a path to your fork.
 
 ```ruby
 gem 'react_on_rails', path: '../relative/path/to/react_on_rails'
-```
+```                                                             
+
+Then run `bundle`.
 
 The main installer can be run with ```rails generate react_on_rails:install```
 
+Then use yalc to add the npm module. 
+
+Be sure that your ran this first at the top level of React on Rails
+
+```
+yalc publish
+```
+
+Then add the node package to your test app:
+
+```
+yalc add react-on-rails
+```
+
 ### Testing the Generator
 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.
 
@@ -255,6 +230,12 @@ You can run specific linting for directories or files by using `docker-compose r
 
 `docker-compose run lint bash` sets you up to run from the container command line.
 
+### Updating Rubocop
+2 files require updating to update the Rubocop version:
+
+1. `react_on_rails.gemspec`
+2. `spec/dummy/Gemfile`
+
 ### Docker CI - Test and Linting
 Docker CI and Tests containers have a xvfd server automatically started for headless browser testing with selenium and Firefox.