The React on Rails Doctrine

By Justin Gordon, January 26, 2016

This document is an extension and complement to The Rails Doctrine. If you haven't read that document, I suggest you do so first.

To paraphrase the React on Rails Introduction, 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 release separate npm packages or Ruby gems. For example, we needed an easy way to integrate Twitter Bootstrap with Webpack, and we released the npm 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, using the webpack-dev-server package. This works for both using an Express server 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 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 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.

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

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, loaded from bootstrap-loader. Common UI styles.
• Lodash: Swiss army knife of utilities.
• React: UI components.
• React Router: Provider of deep links for client-side application.
• Redux: Flux implementation (aka "state container").

JavaScript Tooling

• Babel: Transpiler for ES6 into ES5 and much more.
• ESLint
• Webpack: 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.

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.
• 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 standard 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! 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 or a pull request. If you'd like to join our private Slack channel, please email us a request.