react_on_rails 13.3.5 → 14.0.0

data/docs/javascript/server-rendering-tips.md

@@ -1,55 +0,0 @@
-# Server Rendering Tips
-
-For the best performance with Server Rendering, consider using [React on Rails Pro]
-
-
-## General Tips
-- Your code can't reference `document`. Server side JS execution does not have access to `document`,
-  so jQuery and some other libs won't work in this environment. You can debug this by putting in
-  `console.log` statements in your code.
-- You can conditionally avoid running code that references document by either checking if `window`
-  is defined or using the "railsContext" 
-  your top level react component. Since the passed in props Hash from the view helper applies to
-  client and server side code, the best way to do this is to use a Render-Function.
-- If you're serious about server rendering, it's worth the effort to have different entry points for client and server rendering. It's worth the extra complexity. The point is that you have separate files for top level client or server side, and you pass some extra option indicating that rendering is happening server side.
-- You can enable Node.js server rendering via [React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
-
-## Troubleshooting Server Rendering
-
-1. First be sure your code works with server rendering disabled (`prerender: false`)
-2. Be sure that `config.trace` is true. You will get the server invocation code that renders your component. If you're not using Webpacker, you will also get the whole file used to setup the JavaScript context.
-
-## CSS
-Server bundles must always have CSS Extracted
-
-## setTimeout, setInterval, and clearTimeout
-
-These methods are polyfilled for server rendering to be no-ops. We log calls to these when in `trace` mode. In the past, some libraries, namely babel-polyfill, did call setTimout. 
-
-Here's an example of this which shows the line numbers that end up calling setTimeout:
-```
-➜  ~/shakacode/react_on_rails/gen-examples/examples/basic-server-rendering (add-rails-helper-to-generator u=) ✗ export SERVER_TRACE_REACT_ON_RAILS=TRUE
-➜  ~/shakacode/react_on_rails/gen-examples/examples/basic-server-rendering (add-rails-helper-to-generator u=) ✗ rspec 
-Hello World
-Building Webpack client-rendering assets...
-Completed building Webpack client-rendering assets.
-ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-react_renderer.rb: 92
-wrote file tmp/server-generated.js
-ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-react_renderer.rb: 92
-wrote file tmp/base_js_code.js
-ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-[SERVER] setTimeout is not defined for execJS. See https://github.com/sstephenson/execjs#faq. Note babel-polyfill will call this.
-[SERVER] at setTimeout (<eval>:31:17)
-at defer (<eval>:4422:8)
-at setImmediate (<eval>:4387:6)
-at notify (<eval>:4481:16)
-at module.exports (<eval>:4490:6)
-at notify (<eval>:4081:4)
-at Promise.$resolve (<eval>:4189:8)
-at <eval>:793:18
-at Function.resolve (<eval>:4265:6)
-  the hello world example works
-```

data/docs/javascript/troubleshooting-when-using-webpacker.md

@@ -1,90 +0,0 @@
-## Context
-
-Rails: 5.0.2
-react_on_rails: upgraded from 6.6.0 to 9.0.3
-
-## The failure
-
-Rspec failing with
-```
-Failure/Error: raise Webpacker::Manifest::MissingEntryError, missing_file_from_manifest_error(name)
-     
-     Webpacker::Manifest::MissingEntryError:
-       Webpacker can't find webpack-bundle.js in /home/user/ws/pp/code/pp-core-checkout_spa_update_npm/public/webpack-test/manifest.json. Possible causes:
-       1. You want to set webpacker.yml value of compile to true for your environment
-          unless you are using the `webpack -w` or the webpack-dev-server.
-       2. Webpack has not yet re-run to reflect updates.
-       3. You have misconfigured Webpacker's config/webpacker.yml file.
-       4. Your Webpack configuration is not creating a manifest.
-       Your manifest contains:
-       {
-         "main.css": "/webpack-test/main-bundle.css",
-         "main.js": "/webpack-test/main-dde0e05a2817931424c3.js"
-       }
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/webpacker-3.0.1/lib/webpacker/manifest.rb:44:in `handle_missing_entry'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/webpacker-3.0.1/lib/webpacker/manifest.rb:40:in `find'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/webpacker-3.0.1/lib/webpacker/manifest.rb:27:in `lookup'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/utils.rb:145:in `bundle_js_file_path_from_webpacker'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/utils.rb:90:in `bundle_js_file_path'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb:56:in `block in all_compiled_assets'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb:55:in `map'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb:55:in `all_compiled_assets'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb:35:in `stale_generated_webpack_files'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper/ensure_assets_compiled.rb:34:in `call'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper.rb:85:in `ensure_assets_compiled'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/react_on_rails-9.0.3/lib/react_on_rails/test_helper.rb:39:in `block (2 levels) in configure_rspec_to_compile_assets'
-     # /home/user/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/rspec-core-3.5.4/lib/rspec/core/example.rb:443:in `instance_exec'
-...
-```
-
-At the same time dev/prod environments works fine (with extra webpack calling step outside rails).
-
-## Configs
-
-### webpack.config.js
-
-```js
-...
-const ManifestPlugin = require('webpack-manifest-plugin');
-...
-const { output } = webpackConfigLoader(configPath);
-...
-  output: {
-    filename: '[name]-[hash].js',
-
-    // Leading and trailing slashes ARE necessary.
-    publicPath: output.publicPath,
-    path: output.path,
-  },
-...
-  plugins: [
-    ...
-    new ManifestPlugin({
-      publicPath: output.publicPath,
-      writeToFileEmit: true
-    }),
-   ...
-  ]
-...
-```
-
-### config/webpacker.yml
-
-is default from sample appliction v9.x
-
-### config/initializers/react_on_rails.rb
-
-```ruby
-  ...
-  # Define the files we need to check for webpack compilation when running tests.
-  config.webpack_generated_files = %w( webpack-bundle.js main-bundle.css )
-  ...
-```
-
-## The problem
-
-When `ReactOnRails.configuration.webpack_generated_files` is specified, it prevents usage of `manifest.json`
-
-## Solution
-
-Removing of `config.webpack_generated_files` from `config/initializers/react_on_rails.rb` resolving issue.

data/docs/javascript/webpack-v1-notes.md

@@ -1,23 +0,0 @@
-# Webpack V1 Tips
-
-The following only apply to Webpack V1. Take 1 hour and update to v2! It's worth it!
-
-## Use the `--bail` Option When Running Webpack for CI or Deployments if using Webpack V1
-For your scripts that statically build your Webpack bundles, use the `--bail` option. This will ensure that CI and your product deployment **halt** if Webpack cannot complete! For more details, see the documentation for [Webpack's `--bail` option](https://webpack.js.org/configuration/other-options/#bail). Note, you might not want to use the `--bail` option if you just want to depend on Webpack returning a non-zero error code and you want to see all the errors, rather than only the first error.
-
-
-## Entry Points
-You should ensure you configure the entry points correctly for webpack if you want to break out libraries into a "vendor" bundle where your libraries are packaged separately from your app's code. If you send web clients your vendor bundle separately from your app bundles, then web clients might have the vendor bundle cached while they receive updates for your app.
-
-You need both include `react-dom` and `react` as values for `entry`, like this:
-
-```
-  entry: {
-
-    // See use of 'vendor' in the CommonsChunkPlugin inclusion below.
-    vendor: [
-      'babel-core/polyfill',
-      'react',
-      'react-dom',
-    ],
-```

data/docs/javascript/webpack.md

@@ -1,22 +0,0 @@
-# Webpack Tips
-
-## Where do I learn about advanced Webpack setups, such as with "CSS Modules", "Code Splitting", etc
-You can try out example app, [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial). We're building comprehensive production examples in our new, premium product, [**React on Rails Pro**](https://forum.shakacode.com/t/introducing-react-on-rails-pro-subscriptions/785). If you're interested, please see the details in [this forum post](https://forum.shakacode.com/t/introducing-react-on-rails-pro-subscriptions/785).
-
-## Webpack v1 or v2?
-We recommend using Webpack version 2.3.1 or greater.
-
-## yarn or npm?
-Yarn is the current recommendation!
-
-## Entry Points
-
-You should ensure you configure the entry points correctly for webpack if you want to break out libraries into a "vendor" bundle where your libraries are packaged separately from your app's code. If you send web clients your vendor bundle separately from your app bundles, then web clients might have the vendor bundle cached while they receive updates for your app.
-
-Webpack v2 makes this very convenient! See:
-
-* [Implicit Common Vendor Chunk](https://webpack.js.org/guides/code-splitting-libraries/#implicit-common-vendor-chunk)
-* [Manifest File](https://webpack.js.org/guides/code-splitting-libraries/#manifest-file)
-
-## Webpack v4
-Webpack v4 is heartily recommended. If you need help with migrating your project to Webpack v4, please contact me, [justin@shakacode.com](mailto:justin@shakacode.com).

data/docs/misc/articles.md

@@ -1,20 +0,0 @@
-# Articles, Videos, and Podcasts
-
-## Articles
-
-* [Introducing React on Rails v9 with Webpacker Support](https://blog.shakacode.com/introducing-react-on-rails-v9-with-webpacker-support-f2584c6c8fa4) for an overview of the integration of React on Rails with Webpacker.
-* [Webpacker Lite: Why Fork Webpacker?](https://blog.shakacode.com/webpacker-lite-why-fork-webpacker-f0a7707fac92)
-* [React on Rails, 2000+ 🌟 Stars](https://medium.com/shakacode/react-on-rails-2000-stars-32ff5cfacfbf#.6gmfb2gpy)
-* [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724)
-* [Simple Tutorial](https://www.shakacode.com/react-on-rails/docs/guides/tutorial/).
-
-## Videos
-
-*  [Video of running the v9 installer with Webpacker v3](https://youtu.be/M0WUM_XPaII). History, motivations, philosophy, and overview.
-1. [GORUCO 2017: Front-End Sadness to Happiness: The React on Rails Story by Justin Gordon](https://www.youtube.com/watch?v=SGkTvKRPYrk)
-2. [egghead.io: Creating a component with React on Rails](https://egghead.io/lessons/react-creating-a-component-with-react-on-rails)
-3. [egghead.io: Creating a redux component with React on Rails](https://egghead.io/lessons/react-add-redux-state-management-to-a-react-on-rails-project)
-4. [React On Rails Tutorial Series](https://www.youtube.com/playlist?list=PL5VAKH-U1M6dj84BApfUtvBjvF-0-JfEU)
-  1. [History and Motivation](https://youtu.be/F4oymbUHvoY)
-  2. [Basic Tutorial Walkthrough](https://youtu.be/_bjScw60FBk)
-  3. [Code Walkthrough](https://youtu.be/McQ9UM-_ocQ)

data/docs/misc/code_of_conduct.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/docs/misc/doctrine.md

@@ -1,77 +0,0 @@
-# The React on Rails Doctrine
-
-By Justin Gordon, January 26, 2016
-
-This document is an extension and complement to [The Rails Doctrine](http://rubyonrails.org/doctrine/). If you haven't read that document, I suggest you do so first.
-
-As stated in the [React on Rails README](https://www.shakacode.com/react-on-rails/docs/), the project objective is to provide an opinionated and optimal framework for integrating **Ruby on Rails** with modern JavaScript tooling and libraries. When considering what goes into **react_on_rails**, we ask ourselves, is the functionality related to the intersection of using Rails and with modern JavaScript? A good example is view helper integration of React components on a Rails view. If the answer is yes, then the functionality belongs right here. In other cases, we're releasing separate npm packages or Ruby gems. For example, we needed an easy way to integrate [Twitter Bootstrap](http://getbootstrap.com/) with Webpack, and we released the [npm bootstrap-loader](https://github.com/shakacode/bootstrap-loader/).
-
-Besides the project objective, let's stick with the "Rails Doctrine" and keep the following in mind.
-
-## Optimize for Programmer Happiness
-The React on Rails setup provides several key components related to front-end developer happiness:
-
-1. [Hot reloading of both JavaScript and CSS](https://gaearon.github.io/react-hot-loader/), via the [webpack dev server](https://webpack.github.io/docs/webpack-dev-server.html). This works for both using an [express server](http://expressjs.com/) to load stubs for the ajax requests, as well as using a live Rails server. **Oh yes**, your Rails server can do hot reloading!
-2. [CSS modules](https://github.com/css-modules/webpack-demo) which remove the madness of a global namespace for CSS. We organize our CSS (Sass, actually) right next to our JavaScript React component files. This means no more creating long class names to ensure that CSS picks up the right styles.
-3. [ES6 JavaScript](http://es6-features.org/#Constants) is a great language for client side coding, much more so than Ruby due to the asynchronous nature of UI programming.
-4. JavaScript libraries and tooling work better in the native node way, rather than via some aspect of Sprockets and the Rails Asset Pipeline. We find way less frustration this way, especially from being able to get the latest advances with the rest of the JavaScript community. Why complicated beautiful JavaScript tooling Rails asset pipeline complexity?
-5. We want our JavaScript from npm. Getting JavaScript from rubygems.org is comparatively frustrating.
-6. Happiness for us is actively participating in open source, so we want to be where the action is, which is with the npm libraries on github.com.
-7. You can get set up on React on Rails **FAST** using our application generator.
-8. By placing all client-side development inside of the `/client` directory, pure JavaScript developers can productively do development separate from Rails. Instead of Rails APIs, stub APIs on an express server can provide a simple backend, allowing for rapid iteration of UI prototypes.
-9. Just because we're not relying on the Rails asset pipeline for ES6 conversion does not mean that we're deploying Rails apps in any different way. We still use the asset pipeline to include our Webpack compiled JavaScript. This only requires a few small modifications, as explained in [our heroku deployment documentation](https://www.shakacode.com/react-on-rails/docs/deployment/heroku-deployment/).
-
-## Convention over Configuration
-* React on Rails has taken the hard work out of figuring out the JavaScript tooling that works best with Rails. Not only could you spend lots of time researching different tooling, but then you'd have to figure out how to splice it all together. This is where a lot of "JavaScript fatigue" comes from. The following keep the code clean and consistent:
-* [Style Guide](https://www.shakacode.com/react-on-rails/docs/misc/style/)
-* [linters](https://www.shakacode.com/react-on-rails/docs/contributor-info/linters/)
-
-We're big believers in this quote from the Rails Doctrine:
-
-> The same goes even when you understand how all the pieces go together. When there’s an obvious next step for every change, we can scoot through the many parts of an application that is the same or very similar to all the other applications that went before it. A place for everything and everything in its place. Constraints liberate even the most able minds.
-
-
-## The Menu Is Omakase
-Here's the chef's selection from the React on Rails community:
-
-### Libraries
-* [Bootstrap](http://getbootstrap.com/), loaded from [bootstrap-loader](https://github.com/shakacode/bootstrap-loader/). Common UI styles.
-* [Lodash](https://lodash.com/): Swiss army knife of utilities.
-* [React](https://facebook.github.io/react/): UI components.
-* [React-Router](https://github.com/reactjs/react-router): Provider of deep links for client-side application.
-* [Redux](https://github.com/reactjs/redux): Flux implementation (aka "state container").
-
-### JavaScript Tooling
-* [Babel](https://babeljs.io/): Transpiler for ES6 into ES5 and much more.
-* [EsLint](http://eslint.org/)
-* [Webpack](http://webpack.github.io/): Generator of deployment assets and provider of hot module reloading.
-
-By having a common set of tools, we can discuss what we should or shouldn't be using. Thus, this takes out the "JavaScript Fatigue" from having too many unclear choices in the JavaScript world.
-
-By the way, we're *not* omakase for standard Rails. That would be CoffeeScript. However, the Rails Doctrine makes it clear that non-standard menu choices are certainly welcome!
-
-## No One Paradigm
-React on Rails fits into the "No One Paradigm" of the Rails ecosystem from the perspective that it rocks for client side development with Rails, even though it's a totally different language than the server code written in Ruby.
-
-## Exalt Beautiful Code
-ES5 was ugly. ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, fully linted with the ShakaCode linters, and organized per our recommended project structure is beautiful. Don't take our word for it. Take a look at the component sample code in the [react-webpack-rails-tutorial sample code](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/client/app/bundles/comments).
-
-## Value Integrated Systems
-Assuming that you're building the type of app that's a good fit for Rails (document/database based with lots of business rules), the tight integration of modern JavaScript with React on top of Ruby on Rails is better than building a pure client side app and separate microservices. Here's why:
-
-* Via React on Rails, we can seamlessly integrate React UI components with Rails.
-* Tight integration allows for trivial set up of server rendering of React on top of Rails, complete with support for fragment caching of the server rendered HTML, and integration with [Turbolinks](https://github.com/turbolinks/turbolinks).
-* Tight integration allows mixing and matching Rails pages with React driven pages, even on the same page. Not every part of a UI requires the high fidelity achievable using React. Many existing apps may have hundreds of standards Rails forms. Support for mixing and matching React with Rails forms provides the best of both worlds.
-
-## Progress over Stability
-React on Rails will maintain an active pace of development, to keep up with:
-
-* Community suggestions.
-* New client side tooling, libraries, and techniques.
-* Updates to Rails.
-
-## Raise a Big Tent
-React on Rails is definitely a part of the big tent of Rails. Plus, React on Rails provides its own big tent. A huge benefit of the React on Rails system is simple integration with Webpack and NPM, allowing integration with almost any library available on [npm](https://www.npmjs.org/)! The integration with Webpack also allows for other Webpack supported build tools.
-
-## Thanks!
-Thanks for reading and being a part of the React on Rails community. Feedback on this document and *anything* in React on Rails is welcome. Please [open an issue](https://github.com/shakacode/react_on_rails/issues/new) or a pull request. If you'd like to join our private Slack channel, please [email](mailto:contact@shakacode.com) us a request.

data/docs/misc/style.md

@@ -1,33 +0,0 @@
-# Code Style
-This document describes the coding style of [ShakaCode](http://www.shakacode.com). Yes, it's opinionated, as all style guidelines should be. We shall put as little as possible into this guide and instead rely on:
-
-* Use of linters with our standard linter configuration.
-* References to existing style guidelines that support the linter configuration.
-* Anything additional goes next.
-
-## Client Side JavaScript and React
-* See the [Shakacode JavaScript Style Guide](https://github.com/shakacode/style-guide-javascript)
-
-## Style Guides to Follow
-Follow these style guidelines per the linter configuration. Basically, lint your code and if you have questions about the suggested fixes, look here:
-
-### Ruby Coding Standards
-* [ShakaCode Ruby Coding Standards](https://github.com/shakacode/style-guide-ruby)
-* [Ruby Documentation](http://guides.rubyonrails.org/api_documentation_guidelines.html)
-
-### JavaScript Coding Standards
-* [ShakaCode Javascript](https://github.com/shakacode/style-guide-javascript)
-* Use the [eslint-config-shakacode](https://github.com/shakacode/style-guide-javascript/tree/master/packages/eslint-config-shakacode) npm package with eslint.
-* [JSDoc](http://usejsdoc.org/)
-
-### Git coding Standards
-* [Git Coding Standards](http://chlg.co/1GV2m9p)
-
-### Sass Coding Standards
-* [Sass Guidelines](http://sass-guidelin.es/) by [Hugo Giraudel](http://hugogiraudel.com/)
-* [Github Front End Guidelines](http://primercss.io/guidelines/)
-
-# Git Usage
-* Follow a github-flow model where you branch off of master for features.
-* Before merging a branch to master, rebase it on top of master, by using command like `git fetch; git checkout my-branch; git rebase -i origin/master`. Clean up your commit message at this point. Be super careful to communicate with anybody else working on this branch and do not do this when others have uncommitted changes. Ideally, your merge of your feature back to master should be one nice commit.
-* Run hosted CI and code coverage.

data/docs/misc/tips.md

@@ -1,10 +0,0 @@
-# Tips
-+ **DO NOT RUN `rails s`** and instead run 
-
-    `foreman start -f Procfile.dev`
-
-    to automatically start the webpack file watchers that will regenerate your JavaScript. Note, RSpec does not automatically rebuild the bundle files, so you could get incorrect results from your tests if you change the client code and do not rebuild the bundles. The same problem occurs when pulling down changes from GitHub and running tests without first rebuilding the bundles.
-+ The default for rendering right now is `prerender: false`. **NOTE:**  Server side rendering does not work for some components that use an async setup for server rendering. You can configure the default for prerender in your config.
-+ You can expose either a React component or a function that returns a React component. If you wish to create a React component via a function, rather than simply props, then you need to set the property "generator" on that helper invocation to true (or change the defaults). When that is done, the function is invoked with a single parameter of "props", and that function should return a React element.
-+ Be sure you can first render your react component **client only** before you try to debug server rendering!
-+ Open up the HTML source and take a look at the generated HTML and the JavaScript to see what's going on under the covers. Note that when server rendering is turned on, then you'll see the server rendered react components. When server rendering is turned off, then you'll only see the `div` element where the in-line JavaScript will render the component. You might also notice how the props you pass (a Ruby Hash) becomes in-line JavaScript on the HTML page.

data/docs/outdated/deferred-rendering.md

@@ -1,39 +0,0 @@
-# Deferred Rendering
-
-Please see [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/] if you are interested in code splitting using
-[loadable-components.com](https://loadable-components.com/docs) with React on Rails.
-
------
-
-What is code splitting? From the webpack documentation:
-
-> For big web apps it’s not efficient to put all code into a single file, especially if some blocks of code are only required under some circumstances. Webpack has a feature to split your codebase into “chunks” which are loaded on demand. Some other bundlers call them “layers”, “rollups”, or “fragments”. This feature is called “code splitting”.
-
-## Server Rendering and Code Splitting
-
-Let's say you're requesting a page that needs to fetch a code chunk from the server before it's able to render. If you do all your rendering on the client side, you don't have to do anything special. However, if the page is rendered on the server, you'll find that React will spit out the following error:
-
-> Warning: React attempted to reuse markup in a container but the checksum was invalid. This generally means that you are using server rendering and the markup generated on the server was not what the client was expecting. React injected new markup to compensate which works but you have lost many of the benefits of server rendering. Instead, figure out why the markup being generated is different on the client or server:
-
-> (client) <!-- react-empty: 1 -
-
-> (server) <div data-reactroot="
-<!--This comment is here because the comment beginning on line 13 messes up Sublime's markdown parsing-->
-
-Different markup is generated on the client than on the server. Why does this happen? When you register a component or Render-Function with `ReactOnRails.register`, React on Rails will by default render the component as soon as the page loads. However, code splitting requires that components render at a later time when the JavaScript chunks have loaded.
-
-## Solution
-
-To prevent this, you have to wait until the code chunk is fetched before doing the initial render on the client side. To accomplish this, react on rails allows you to register a renderer. This works just like registering a Render-Function, except that the function you pass takes three arguments: `renderer(props, railsContext, domNodeId)`, and is responsible for calling `ReactDOM.render` or `ReactDOM.hydrate` to render the component to the DOM. React on rails will automatically detect when a Render-Function takes three arguments, and will **not** call `ReactDOM.render` or `ReactDOM.hydrate`, instead allowing you to control the initial render yourself. Note, you have to be careful to call `ReactDOM.hydrate` rather than `ReactDOM.render` if you are are server rendering.
-
-
-## Server vs. Client Code Caveats
-
-If you're going to try to do code splitting with server rendered routes, you'll probably need to use seperate route definitions for client and server to prevent code splitting from happening for the server bundle. The server bundle should be one file containing all the JavaScript code. This will require you to have seperate webpack configurations for client and server.
-
-Do not attempt to register a renderer function on the server. Instead, register either a Render-Function or a component. If you register a renderer in the server bundle, you'll get an error when react on rails tries to server render the component.
-
-
-## React on Rails Pro
-[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/] includes a complete setup using this technique for code splitting using
-[loadable-components.com](https://loadable-components.com/docs) with React on Rails.

data/docs/outdated/rails-assets-relative-paths.md

@@ -1,195 +0,0 @@
-*Note: this doc reflects using Sprockets for assets and has not been updated for rails/webpacker*
-
-# Using Webpack bundled assets with the Rails Asset Pipeline
-
-**If you're looking to use assets in your react components, look no further. This doc is for you.**
-
-As most of you know, when you spin up a Rails application all of your asset files that live within your `app/assets/` directory will be added into your application's Asset Pipeline. If you would like to view any of these assets (most commonly you'd want to view images), run your rails server in development mode and in a browser visit a url similar to: `localhost:3000/assets/sample_image.png`. In this case, if I had an image `sample_image.png` in my `app/assets/images/` directory, visiting the url `localhost:3000/assets/sample_image.png` in a browser would display the image to me. Meaning that `/assets/sample_image.png` is my path to that individual asset.
-
-## The Problem
-
-Sometimes we would like to use images directly in our react components or even component specific CSS. This can cause problems because it is difficult to maintain the relative path to assets in our pipeline. Normally, we would use erb to get around this, using something like `<img src="<%= asset_path('my-image.png') %>" />`. Unfortunately, that will not play well with webpack.
-
-Now we could always just place these assets in our `app/assets/` directory like normal and then reference them in our react with things like `<img src="/assets/asset-name.ext" />`, and that would work! But that also will move this image out of our client side app, which isn't always ideal. Also hardcoding the path to an asset isn't a good approach considering file paths can always change, and that would then require a source code change. That's just no bueno.
-
-So how do we get around this? And find the relative paths to our assets without hardcoding the paths?
-
-## The Solution: The lowdown on Webpack's url-loader & file-loader, outputPaths and publicPaths
-
-Loaders are an incredibly useful part of Webpack. Simply put, they allow you to load and bundle different types of sources/files (you can load anything from images, CSS, to CoffeeScript).
-
-##### Url Loader vs. File Loader
-
-Two very common, and quite useful, Webpack loaders are the [url-loader](https://github.com/webpack-contrib/url-loader) and the [file-loader](https://github.com/webpack-contrib/file-loader). They allow you to load and access files in an easy manner. Both of these loaders are incredibly similar to one another, and in fact work together to accomplish their goals, with a very slight difference. The url-loader will load any file(s) and when accessed, will return a Data Url that can be used to access the file(s) (commonly used to inline images). File-loader on the other hand, will bundle and output the file(s) to a desired directory so they can live in the assets on your webserver along with your outputted webpack bundle. These bundled assets can then be accessed by their public paths, making it very easy to include and use them in your JavaScript code.
-
-The url-loader is great to use for smaller images! It is most commonly used with a set byte limit on the size of the files that can be loaded. When this is the case, anything below the byte limit will be loaded and returned as a Data Url. Anything that exceeds the byte limit, will delegate to file-loader for loading, passing any set query parameters as well to file-loader (if that sounds like gibberish right now, don't worry. You'll learn all about it soon!).
-
-The benefit of using url-loader first, and falling back on file-loader, is that the use of Data Urls saves HTTP Requests that need to be made to fetch files. That is very important in regards to how fast a webpage will load. Generally speaking, the less HTTP requests that need to be made, the faster a page will load. For more information about usage, and the pros & cons of Data Urls read [here](https://css-tricks.com/data-uris/).
-
-Note: _For the rest of this doc, we will be using file-loader. This is because its usage can be a little bit trickier and it is used as url-loader's back up. Keep in mind that the usage for the two are EXTREMELY similar. For more info about the url-loader's usage, check out its configuration for the `react_on_rails` sample app [here](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.client.base.config.js) (specifically lines 82-84)._
-
-##### Configuring Webpack with file-loader
-
-Once you have added file-loader (or whatever loader you would like to use) to your project, you can start configuring your `webpack.config.js` file to bundle these assets. Inside your `module["loaders"]` list you will add a new object to represent your loader. This loader will include a few attributes:
-
-1. `test`: a regular expression that specifies the types of files that can be loaded.
-2. `loader`: the name of the loader you will be using (in this doc we will be using [file-loader](https://github.com/webpack-contrib/file-loader))
-3. `query`: query parameters are additional configuration options that get passed to the loader. This can either be appended to your `loader` attribute like follows:
-
-
-```javascript
-loader: "file-loader?name=[name].[ext]"
-```
-
-or as a JSON object:
-
-```javascript
-query: {
-  name: "[name].[ext]"
-}
-```
-
-both of these two example above do the exact same thing, just using different syntaxes. For the rest of this doc we will be using the JSON object style. For more information about webpack loaders, read [this](https://webpack.github.io/docs/using-loaders.html).
-
-_For the sake of this doc, we're also going to add a `resolve["alias"]` inside our webpack.config to make it easier to include our assets in our jsx files. In `resolve["alias"]`, simply add:_
-
-```javascript
-'assets': path.resolve('./app/assets')
-```
-
-##### Configuring your file-loader Query Parameters
-
-The first property we'll want to set is our file's resulting name after bundling. For now we're just going to use:
-
-```javascript
-name: "[name][md5:hash].[ext]"
-```
-
-This will just set the name to the file's original name + a md5 digested hash + the extension of the original file (.png, .jpg, etc).
-
-Next we'll set the outputPath for our files. This is the directory we want the files to be placed in after webpack runs. When Webpack runs with file-loader, all files (in this case assets) that have been used in the bundled JavaScript will be bundled and outputted to the output destination. **Keep in mind that react_on_rails outputs by default to the `app/assets/webpack/` directory so when we specify the outputPath here it will be relative the `app/assets/webpack` directory.** You can set the outputPath to whatever you want, in this example we will add it to a directory `/app/assets/webpack/webpack-assets/`, and here's how we would do that:
-
-```javascript
-outputPath: "webpack-assets/"
-```
-
-Note: _You can output these files in the asset pipeline wherever you see fit. My preference is outputting somewhere inside the `app/assets/webpack/` directory just because anything in this directory is already ignored by git due to the react_on_rails generated gitignore, meaning they will not be added by git twice! (once in your `client/app/assets/` and once in your outputted path after webpack bundling)_
-
-Lastly, we will set the publicPath to our file(s). This will be the endpoint on our rails web server that you can visit to reach the asset (if you don't know how this works, read the [intro](#using-webpack-bundled-assets-with-the-rails-asset-pipeline)). If you've been following the previous steps, you know that we set our outputPath for our assets to be absolute at `app/assets/webpack/webpack-assets/`, which your rails app should end up hosting at `/assets/webpack-assets/file-name+hash.ext` when the server is run.
-
-Note: _If you're having a hard time figuring out what an asset's path will be on your rails server, simply run `rake assets:precompile` and `cd public/`. The path from there to your file will then be the path/url on your web server to that asset. On top of this, it is also a good idea to check out [this doc](https://www.shakacode.com/react-on-rails/docs/outdated/rails-assets/) to understand how `react_on_rails` allows us to access these files after precompilation, when Rails applies another hash onto the asset._
-
-Our publicPath setting will match the path to our outputted assets on our rails web server. Given our assets in this example will be outputted to `/app/assets/webpack/webpack-assets/` and hosted at `/assets/webpack-assets/`, our publicPath would be:
-
-```javascript
-publicPath: "/assets/webpack-assets/"
-```
-
-Voila! Your webpack setup is complete.
-
-##### Adding/Using `client/` Assets
-
-Now for the fun part, we actually get to use our client assets now. The first thing you'll want to do is create an assets directory inside your client directory. The best place for this directory is probably at `client/app/assets`. Put any assets you want in there, images, stylesheets, whatever. Now that the assets are in place, we can simply `import` or `require` them in our jsx files for use in our components. For example:
-
-```javascript
-import myImage from 'assets/images/my-image.png'; // This uses the assets alias we created earlier to map to the client/app/assets/ directory followed by `images/my-image.png`
-
-export default class MyImageBox extends React.Component {
-  constructor(props, context) {
-    super(props, context);
-  }
-
-  render() {
-    return <img src={myImage} />
-  }
-}
-```
-
-`myImage` in the example above will resolve to the path of that asset on the web server. Therefore using it as an img's source would then properly display the image/assets when this react component is rendered.
-
-Note: **Any assets in our `client/` directory that are not imported/required for use in our jsx files will NOT be bundled and outputted by webpack.**
-
-## Summary: Welcome people who are tired of reading
-
-If you've read this far, you probably have a grip on everything. If you didn't, and want a condensed version, here you go:
-
-- Add webpack's file-loader to your project
-- Add a new loader module in your webpack.config.js file
-- Set this loader's test attribute to a regex of the file extensions you would like to load
-- Set the loader attribute to "file-loader"
-- Set name to something like `"[name][md5:hash].[ext]"`
-- Set outputPath attribute to directory of choice, relative to `app/assets/webpack` directory
-- Set publicPath attribute, this should be the same as where the rails asset pipeline will serve your asset(s) on the server. See [this](#configuring-your-file-loader-query-parameters) for more info.
-- Add assets directory in `client/app/`, and place whatever you would like in there
-- Import or Require these files in your jsx and use them all you want!
-
-### Here's a full example of a webpack.config.js configured with file-loader to load images:
-
-```javascript
-const webpack = require('webpack');
-const path = require('path');
-
-const devBuild = process.env.NODE_ENV !== 'production';
-const nodeEnv = devBuild ? 'development' : 'production';
-
-module.exports = {
-  entry: [
-    './app/bundles/HelloWorld/startup/registration',
-  ],
-
-  output: {
-    filename: 'hello-world-bundle.js',
-    path: '../app/assets/webpack'
-  },
-
-  resolve: {
-    extensions: ['', '.js', '.jsx'],
-    alias: {
-      assets: path.resolve('./app/assets'), // Makes it easier to reference our assets in jsx files
-      react: path.resolve('./node_modules/react'),
-      'react-dom': path.resolve('./node_modules/react-dom'),
-    },
-  },
-
-  plugins: [
-    new webpack.DefinePlugin({
-      'process.env': {
-        NODE_ENV: JSON.stringify(nodeEnv),
-      }
-    })
-  ],
-  module: {
-    rules: [
-      {
-        test: /\.jsx?$/,
-        loader: 'babel-loader',
-        exclude: /node_modules/,
-      },
-      {
-        test: require.resolve('react'),
-        use: {
-          loader: 'imports-loader',
-          options: {
-            shim: 'es5-shim/es5-shim',
-            sham: 'es5-shim/es5-sham',
-          },
-        }
-      },
-      {
-        // The important stuff
-        test: /\.(jpg|jpeg|png)(\?.*)?$/, // Load only .jpg .jpeg, and .png files
-        use: {
-          loader: 'file-loader',
-          options: {
-            name: '[name][md5:hash].[ext]', // Name of bundled asset
-            outputPath: 'webpack-assets/', // Output location for assets. Final: `app/assets/webpack/webpack-assets/`
-            publicPath: '/assets/webpack-assets/' // Endpoint asset can be found at on Rails server
-          }
-        }
-      }
-    ]
-  }
-};
-```
-
-If you'd like to understand how react_on_rails handles these bundled assets after asset precompilation and in production mode, check out: [Rails Assets](https://www.shakacode.com/react-on-rails/docs/outdated/rails-assets/).