react_on_rails 10.0.2 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: efb94d1fdde90ef09be7d953e3b139fc5c6b4d9a
-  data.tar.gz: 45545dd16a35f4ddb94bd6bb9b6e55b9f9a3c639
+SHA256:
+  metadata.gz: 9cca491248aecfc5e1611843368b67c30116e92228eebd638ae6d0a9ecc26c79
+  data.tar.gz: 54aed2d1114c1cd25ad4fc7efeaf1adce4f352d38e79f07a85594b359383ee0c
 SHA512:
-  metadata.gz: ea10bc4fce477f47749c58e63033e71e538ba75fc8b8faa75be1e0fd23910b2082c2b03974e5c352ccbe2ec8cf6faf1e2dbb86b3a975d4992f134812b5866a6c
-  data.tar.gz: add6268789bca2b97ca812ace89ad98b14721e112768c3da60637b6eeb71541a284b3de27798e8494a75f22fe5773dbcc03c6fc51ad6d3acd193b40144742733
+  metadata.gz: ec6eeca7c1606a9deb34daa5675aaf8df3756df75eaa8585d6667e2fd5ef56b546ce6fa2806f532dfad47823a4d681ad83c3767cf8a66e874e80ebbb5bb28cb2
+  data.tar.gz: 9133bfcc208013634808483c32805965caf1ca3ee2980d378f1070db60865aefdcf2b99ef09a9aae2797fb388769f3693e6c315eccc1d7d4039aa97a8ff79a6f

data/.rubocop.yml

@@ -3,7 +3,7 @@
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.1
 
   Include:
     - '**/Rakefile'

data/CHANGELOG.md

@@ -8,6 +8,15 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
+### [10.1.0] - 2018-01-23
+#### Added
+- Added 2 cache helpers: ReactOnRails::Utils.bundle_file_name(bundle_name) and ReactOnRails::Utils.server_bundle_file_name
+for easy access to the hashed filenames for use in cache keys by [justin808](https://github.com/justin808).
+
+#### Fixed
+- Use redux component in generated redux Hello World example: [PR 1006](https://github.com/shakacode/react_on_rails/pull/1006) by [lewaabahmad](https://github.com/lewaabahmad).
+- Fixed `Utils.bundle_js_file_path` generating the incorrect path for `manifest.json` in webpacker projects: [Issue #1011](https://github.com/shakacode/react_on_rails/issues/1011) by [elstgav](https://github.com/elstgav)
+
 ### [10.0.2] - 2017-11-10
 #### Fixed
 - Remove unnecessary dependencies from released NPM package: [PR 968](https://github.com/shakacode/react_on_rails/pull/968) by [tricknotes](https://github.com/tricknotes).
@@ -46,7 +55,7 @@ Updated React on Rails to depend on [rails/webpacker](https://github.com/rails/w
 
 
 #### 9.0 from 8.x. Upgrade Instructions
-Moved to [our additional reading documentation](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/upgrading-react-on-rails#from-version-8).
+Moved to [our documentation](docs/basics/upgrading-react-on-rails.md#upgrading-to-version-9).
 
 ### [8.0.7] - 2017-08-16
 #### Fixed
@@ -670,8 +679,9 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/10.0.1...master
-[10.0.2]: https://github.com/shakacode/react_on_rails/compare/10.0.0...10.0.2
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/10.1.0...master
+[10.1.0]: https://github.com/shakacode/react_on_rails/compare/10.0.2...10.1.0
+[10.0.2]: https://github.com/shakacode/react_on_rails/compare/10.0.1...10.0.2
 [10.0.1]: https://github.com/shakacode/react_on_rails/compare/10.0.0...10.0.1
 [10.0.0]: https://github.com/shakacode/react_on_rails/compare/9.0.3...10.0.0
 [9.0.3]: https://github.com/shakacode/react_on_rails/compare/9.0.2...9.0.3

data/Dockerfile_tests

@@ -0,0 +1,12 @@
+FROM dylangrafmyre/docker-ci
+
+WORKDIR /app/
+
+COPY ["/lib/react_on_rails/version.rb", "/app/lib/react_on_rails/"]
+COPY ["Gemfile", "Gemfile.lock", "react_on_rails.gemspec", "rakelib/", "/app/"]
+COPY ["/spec/dummy/Gemfile", "/spec/dummy/Gemfile.lock", "/app/spec/dummy/"]
+RUN  bundle install --gemfile=spec/dummy/Gemfile
+
+ENV DISPLAY :99
+ENTRYPOINT service xvfd start \
+           && rake

data/Gemfile

@@ -14,7 +14,7 @@ gem "jbuilder", "~> 2.0"
 gem "jquery-rails"
 gem "mini_racer"
 gem "puma"
-gem "rails", "5.1.2"
+gem "rails", "5.1.4"
 gem "rails_12factor"
 gem "rubocop", "~> 0.50", require: false
 gem "ruby-lint", require: false

data/PROJECTS.md

@@ -5,9 +5,10 @@
 ## Commercial Products Live
 * **[Friends and Guests](https://www.friendsandguests.com/)**, the signature product of [ShakaCode](http://www.shakacode.com), which is a "Network Connecting Hosts and Guests".
 * **[KissKissBankBank](https://www.kisskissbankbank.com/)**, large French crowdfunding platform.
-* **[Nootrobox](https://nootrobox.com)**: Web ecommerce site for "biohacking" products.
+* **[HVMN](https://hvmn.com)**: Web ecommerce site for "biohacking" products.
 * **[GuavaPass](https://guavapass.com/)**: Coaching client of [ShakaCode](http://www.shakacode.com) and React on Rails fan!
 * **[Pivotal Tracker](http://www.pivotaltracker.com/)**: The first (and most-loved) agile project management tool built on Rails.  React on Rails has greatly simplified integration and workflow for our React components in Rails!
+* **[Estately](https://www.estately.com)**: Home search.
 * **[Blink Inc](https://www.blinkinc.com)**: Website and more built by [ShakaCode](http://www.shakacode.com).
 * **[Madrone Analytics](http://madroneco.com/)**: The original client of [ShakaCode](http://www.shakacode.com) that led to the development of React on Rails, as described in [Fast Rich Client Rails Development With Webpack and the ES6 Transpiler](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/).
 * **[Deliveroo](https://deliveroo.co.uk/)**: The leading food delivery site in Europe has gone live with React on Rails, with multi-lingual JavaScript support!

data/README.md

@@ -2,7 +2,7 @@
 
 *If this projects helps you, please give us a star!*
 
-[ShakaCode is hiring team members](http://www.shakacode.com/about/#work-with-us) for our own app, [Friends and Guests](https://www.friendsandguests.com).
+[The ShakaCode team has availability to help your project](http://www.shakacode.com/work). If your team might need my help, please [email me](mailto:justin@shakacode.com) for a free half-hour project consultation, on anything from React on Rails to any aspect of web or mobile application development for both consumer and enterprise products.
 
 # React on Rails v10 is based on Webpacker 3.0!
 
@@ -23,14 +23,14 @@ Given that Webpacker already provides React integration, why would you add React
 
 ----
 
-## Steps to a New App with rails/webpacker v3 plus React on Rails v9:
+## Steps to a New App with rails/webpacker v3 plus latest React on Rails:
 First be sure to run `rails -v` and check that you are using Rails 5.1.3 or above. If you are using an older version of Rails, you'll need to install webpacker with React per the instructions [here](https://github.com/rails/webpacker).
 
 ### Basic installation for a new Rails App
 *See below for steps on an existing Rails app*
 
 1. New Rails app: `rails new my-app --webpack=react`. `cd` into the directory.
-2. Add gem version: `gem 'react_on_rails', '~> 9.0.1'`
+2. Add gem version: `gem 'react_on_rails', '10.0.2' # prefer exact gem version to match npm version`
 3. Run the generator: `rails generate react_on_rails:install`
 4. Start the app: `rails s`
 5. Visit http://localhost:3000/hello_world
@@ -59,7 +59,7 @@ Thank you for considering using [React on Rails](https://github.com/shakacode/re
 
 We at [ShakaCode](http://www.shakacode.com) are a small, boutique, remote-first application development company. We fund this project by:
 
-* Providing priority support and training for anything related to React + Webpack + Rails in our [Coaching Program](http://www.shakacode.com/work/shakacode-coaching-plan.pdf).
+* Providing priority support and training for anything related to React + Webpack + Rails in our [Pro Support program](http://www.shakacode.com/work/shakacode-pro-support.pdf).
 * Building custom web and mobile (React Native) applications. We typically work with a technical founder or CTO and instantly provide a full development team including designers.
 * Migrating **Angular** + Rails to React + Rails. You can see an example of React on Rails and our work converting Angular to React on Rails at [egghead.io](https://egghead.io/browse/frameworks).
 * Augmenting your team to get your product completed more efficiently and quickly.
@@ -68,7 +68,7 @@ My article "[Why Hire ShakaCode?](https://blog.shakacode.com/can-shakacode-help-
 
 If any of this resonates with you, please email me, [justin@shakacode.com](mailto:justin@shakacode.com). I offer a free half-hour project consultation, on anything from React on Rails to any aspect of web or mobile application development for both consumer and enterprise products.
 
-We are **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded developers that wish to work on our projects, including [Friends and Guests](https://www.friendsandguests.com).
+We are **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded developers that wish to work on our projects, including [Hawaii Chee](https://www.hawaiichee.com).
 
 I appreciate your attention and sharing of these offerings with anybody that we can help. Your support allows me to bring you and your team [front-end happiness in the Rails world](https://www.youtube.com/watch?v=SGkTvKRPYrk).
 
@@ -138,11 +138,15 @@ React on Rails integrates Facebook's [React](https://github.com/facebook/react)
 
 + [Features](#features)
 + [Why Webpack?](#why-webpack)
++ [rails/webpacker or custom setup for Webpack?](#webpack-configuration-custom-setup-for-webpack-or-railswebpacker)
 + [Getting Started with an existing Rails app](#getting-started-with-an-existing-rails-app)
     - [Installation Overview](#installation-overview)
     - [Initializer Configuration: config/initializers/react_on_rails.rb](#initializer-configuration)
     - [Including your React Component in your Rails Views](#including-your-react-component-in-your-rails-views)
     - [I18n](#i18n)
+    - [Convert rails-5 API only app to rails app](#convert-rails-5-api-only-app-to-rails-app)
+    - [NPM](#npm)
+    - [Webpacker Configuration](#webpacker-configuration)
 + [How it Works](#how-it-works)
     - [Client-Side Rendering vs. Server-Side Rendering](#client-side-rendering-vs-server-side-rendering)
     - [Building the Bundles](#building-the-bundles)
@@ -179,6 +183,38 @@ This usage of webpack fits neatly and simply into existing Rails apps. You can i
 Compare this to some alternative approaches for SPAs (Single Page Apps) that utilize Webpack and Rails. They will use a separate node server to distribute web pages, JavaScript assets, CSS, etc., and will still use Rails as an API server. A good example of this is our ShakaCode team member Alex's article [
 Universal React with Rails: Part I](https://medium.com/@alexfedoseev/isomorphic-react-with-rails-part-i-440754e82a59).
 
+## Webpack Configuration: custom setup for Webpack or rails/webpacker?
+
+Version 9 of React on Rails added support for the rails/webpacker view helpers so that Webpack produced assets would no longer pass through the Rails asset pipeline. As part of this change, React on Rails added a configuration option to support customization of the node_modules directory. This allowed React on Rails to support the rails/webpacker configuration of the Webpack configuration.
+
+A key decision in your use React on Rails is whether you go with the rails/webpacker default setup or the traditional React on Rails setup of putting all your client side files under the `/client` directory. While there are technically 2 independent choices involved, the directory structure and the mechanism of Webpack configuration, for simplicity sake we'll assume that these choices go together.
+
+### Traditional React on Rails using the /client directory
+
+Until version 9, all React on Rails apps used the `/client` directory for configuring React on Rails in terms of the configuration of Webpack and location of your JavaScript and Webpack files, including the node_modules directory. Version 9 changed the default to `/` for the `node_modules` location using this value in `config/initializers/react_on_rails.rb`: `config.node_modules_location`. 
+
+The [ShakaCode Team](http://www.shakacode.com) _recommends_ this approach for projects beyond the simplest cases as it provides the greatest transparency in your webpack and overall client-side setup. The *big advantage* to this is that almost everything within the `/client` directory will apply if you wish to convert your client-side code to a pure Single Page Application that runs without Rails. This allows you to google for how to do something with Webpack configuration and what applies to a non-Rails app will apply just as well to a React on Rails app.
+
+The two best examples of this patten are the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and the integration test example in [spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy).
+
+In this case, you don't need to understand the nuances of customization of your Wepback config via the [Webpacker mechanism](https://github.com/rails/webpacker/blob/master/docs/webpack.md).
+
+
+### rails/webpacker Setup
+
+Typical rails/webpacker apps have a standard directory structure as documented [here](https://github.com/rails/webpacker/blob/master/docs/folder-structure.md). If you follow the steps in the the [basic tutorial](https://github.com/shakacode/react_on_rails/blob/master/docs/tutorial.md), you will see this pattern in action. In order to customize the Webpack configuration, you need to consult with the [rails/webpacker Webpack configuration](https://github.com/rails/webpacker/blob/master/docs/webpack.md). 
+
+Version 9 made this the default for generated apps for 2 reasons:
+
+1. It's less code to generate and thus less to explain.
+2. `rails/webpacker` might be viewed as a convention in the Rails community.
+
+The *advantage* of this is that there is very little code needed to get started and you don't need to understand really anything about Webpack customization. The *big disadvantage* to this is that you will need to learn the ins and outs of the [rails/webpacker way to customize Webpack]([Webpacker mechanism](https://github.com/rails/webpacker/blob/master/docs/webpack.md)) (not the plain [Webpack way](https://webpack.js.org/)) if you wish to beyond the basic setup, and this sort of knowledge is not going to be particularly applicable if you eventually want to convert your client-side app to a pure Single Page Application that runs without rails.
+
+Overall, consider carefully if you prefer the `rails/webpacker` directory structure and Webpack configuration, over the placement of all client side files within the `/client` directory along with conventional Webpack configuration.
+
+See [Issue 982: Tutorial Generating Correct Project Structure?](https://github.com/shakacode/react_on_rails/issues/982) to discuss this issue.
+
 ## Upgrade
 
 To upgrade existing apps to React on Rails 8 see the [Installation Overview](docs/basics/installation-overview.md)
@@ -187,6 +223,7 @@ To upgrade existing apps to React on Rails 8 see the [Installation Overview](doc
 
 **For more detailed instructions on a fresh Rails app**, see the [React on Rails Basic Tutorial](docs/tutorial.md).
 
+**If you have rails-5 API only project**, Then [convert rails-5 API only app to rails app](#convert-rails-5-api-only-app-to-rails-app) before [getting started](#getting-started-with-an-existing-rails-app).
 1. Add the following to your Gemfile and `bundle install`. We recommend fixing the version of React on Rails, as you will need to keep the exact version in sync with the version in your `client/package.json` file.
 
   ```ruby
@@ -276,7 +313,28 @@ React on Rails provides an option for automatic conversions of Rails `*.yml` loc
 
 See the [How to add I18n](docs/basics/i18n.md) for a summary of adding I18n.
 
-## NPM
+### Convert rails-5 API only app to rails app
+
+1. Go to the directory where you created your app
+
+```
+rails new your-current-app-name
+```
+
+Rails will start creating the app and will skip the files you have already created. If there is some conflict then it will stop and you need to resolve it manually. be careful at this step as it might replace you current code in conflicted files.
+
+2. Resolve conflicts
+
+```
+1. Press "d" to see the difference
+2. If it is only adding lines then press "y" to continue
+3. If it is removeing some of your code then press "n" and add all additions manually
+```
+
+3. Run `bundle install` and follow [Getting started](#getting-started-with-an-existing-rails-app)
+
+
+### NPM
 All JavaScript in React On Rails is loaded from npm: [react-on-rails](https://www.npmjs.com/package/react-on-rails). To manually install this (you did not use the generator), assuming you have a standard configuration, run this command (assuming you are in the directory where you have your `node_modules`):
 
 ```bash
@@ -285,7 +343,7 @@ yarn add react-on-rails
 
 That will install the latest version and update your package.json.
 
-## Webpacker Configuration
+### Webpacker Configuration
 
 React on Rails users should set configuration value `compile` to false, as React on Rails handles compilation for test and production environments.
 
@@ -621,8 +679,11 @@ If you are using [jquery-ujs](https://github.com/rails/jquery-ujs) for AJAX call
 1. Examples in [spec/dummy/app/views/react_router](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/react_router) and follow to the JavaScript code in the [spec/dummy/client/app/startup/ServerRouterApp.jsx](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/startup/ServerRouterApp.jsx).
 1. [Code Splitting docs](./docs/additional-reading/code-splitting.md) for information about how to set up code splitting for server rendered routes.
 
+## Caching and Performance
+Consider fragment and http caching of pages that contain React on Rails components. See [Caching and Performance](./docs/additional-reading/caching-and-performance.md) for more details.
+
 ## Deployment
-* Version 6.0 puts the necessary precompile steps automatically in the rake precompile step. You can, however, disable this by setting certain values to nil in the [config/initializers/react_on_rails.rb](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/config/initializers/react_on_rails.rb).
+* React on Rails puts the necessary precompile steps automatically in the rake precompile step. You can, however, disable this by setting certain values to nil in the [config/initializers/react_on_rails.rb](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/config/initializers/react_on_rails.rb).
   * `config.symlink_non_digested_assets_regex`: Set to nil to turn off the setup of non-js assets.
   * `build_production_command`: Set to nil to turn off the precompilation of the js assets.
 * See the [Heroku Deployment](./docs/additional-reading/heroku-deployment.md) doc for specifics regarding Heroku. The information here should apply to other deployments.
@@ -666,6 +727,7 @@ If you want to use a node server for server rendering, [get in touch](mailto:jus
   + [Hot Reloading of Assets For Rails Development](./docs/additional-reading/hot-reloading-rails-development.md)
   + [Heroku Deployment](./docs/additional-reading/heroku-deployment.md)
   + [Updating Dependencies](./docs/additional-reading/updating-dependencies.md)
+  + [Caching and Performance](./docs/additional-reading/caching-and-performance.md)
 
 + **API**
   + [JavaScript API](./docs/api/javascript-api.md)
@@ -747,7 +809,7 @@ Thank you for considering using [React on Rails](https://github.com/shakacode/re
 
 We at [ShakaCode](http://www.shakacode.com) are a small, boutique, remote-first application development company. We fund this project by:
 
-* Providing priority support and training for anything related to React + Webpack + Rails in our [Coaching Program](http://www.shakacode.com/work/shakacode-coaching-plan.pdf).
+* Providing priority support and training for anything related to React + Webpack + Rails in our [Pro Support program](http://www.shakacode.com/work/shakacode-pro-support.pdf).
 * Building custom web and mobile (React Native) applications. We typically work with a technical founder or CTO and instantly provide a full development team including designers.
 * Migrating **Angular** + Rails to React + Rails. You can see an example of React on Rails and our work converting Angular to React on Rails at [egghead.io](https://egghead.io/browse/frameworks).
 * Augmenting your team to get your product completed more efficiently and quickly.
@@ -756,7 +818,7 @@ My article "[Why Hire ShakaCode?](https://blog.shakacode.com/can-shakacode-help-
 
 If any of this resonates with you, please email me, [justin@shakacode.com](mailto:justin@shakacode.com). I offer a free half-hour project consultation, on anything from React on Rails to any aspect of web or mobile application development for both consumer and enterprise products.
 
-We are **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded developers that wish to work on our projects, including [Friends and Guests](https://www.friendsandguests.com).
+We are **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded developers that wish to work on our projects, including [Hawaii Chee](https://www.hawaiichee.com).
 
 I appreciate your attention and sharing of these offerings with anybody that we can help. Your support allows me to bring you and your team [front-end happiness in the Rails world](https://www.youtube.com/watch?v=SGkTvKRPYrk).
 

data/app/helpers/react_on_rails_helper.rb

@@ -13,7 +13,7 @@ require "react_on_rails/json_output"
 module ReactOnRailsHelper
   include ReactOnRails::Utils::Required
 
-  COMPONENT_HTML_KEY = "componentHtml"
+  COMPONENT_HTML_KEY = "componentHtml".freeze
 
   # The env_javascript_include_tag and env_stylesheet_link_tag support the usage of a webpack
   # dev server for providing the JS and CSS assets during development mode. See
@@ -178,9 +178,7 @@ module ReactOnRailsHelper
   # that contains a data props.
   def redux_store_hydration_data
     return if @registered_stores_defer_render.blank?
-    # rubocop:disable Performance/UnfreezeString
     @registered_stores_defer_render.reduce("".dup) do |accum, redux_store_data|
-      # rubocop:enable Performance/UnfreezeString
       accum << render_redux_store_data(redux_store_data)
     end.html_safe
   end
@@ -447,15 +445,12 @@ module ReactOnRailsHelper
 
   def initialize_redux_stores
     return "" unless @registered_stores.present? || @registered_stores_defer_render.present?
-    declarations = "var reduxProps, store, storeGenerator;\n".dup # rubocop:disable Performance/UnfreezeString
-
+    declarations = "var reduxProps, store, storeGenerator;\n".dup
     all_stores = (@registered_stores || []) + (@registered_stores_defer_render || [])
 
-    # rubocop:disable Performance/UnfreezeString
     result = <<-JS.dup
       ReactOnRails.clearHydratedStores();
     JS
-    # rubocop:enable Performance/UnfreezeString
 
     result << all_stores.each_with_object(declarations) do |redux_store_data, memo|
       store_name = redux_store_data[:store_name]
@@ -516,6 +511,7 @@ module ReactOnRailsHelper
 
     @rails_context.merge(serverSide: server_side)
   end
+  # rubocop:enable Metrics/AbcSize
 
   def replay_console_option(val)
     val.nil? ? ReactOnRails.configuration.replay_console : val
@@ -539,3 +535,4 @@ module ReactOnRailsHelper
     controller.is_a?(ActionMailer::Base)
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/docker-compose.yml

@@ -0,0 +1,11 @@
+lint:
+  image: dylangrafmyre/docker-lint:latest
+  working_dir: /app/
+  volumes:
+    - '.:/app/'
+tests:
+  build: .
+  dockerfile: Dockerfile_tests
+  working_dir: /app/
+  volumes:
+    - '.:/app/'

data/docs/additional-reading/caching-and-performance.md

@@ -0,0 +1,31 @@
+# Caching and Performance
+
+
+## Caching
+
+### Fragment Caching
+
+If you wish to do fragment caching that includes React on Rails rendered components, be sure to
+include the bundle name of your server rendering bundle in your cache key. This is analogous to 
+how Rails puts an MD5 hash of your views in the cache key so that if the views change, then your 
+cache is busted. In the case of React code, if your React code changes, then your bundle name will
+change due to the typical inclusion of a hash in the name.
+
+Call this method to get the server bundle file name:
+
+```ruby
+# Returns the hashed file name of the server bundle when using webpacker.
+# Nececessary fragment-caching keys.
+ReactOnRails::Utils.server_bundle_file_name
+```
+
+### HTTP Caching
+
+When creating a HTTP cache, you want the cache key to include your client bundle files.
+
+Call this method to get the client bundle file name. Note, you have to pass which bundle name.
+
+```ruby
+# Returns the hashed file name when using webpacker. Useful for creating cache keys.
+ReactOnRails::Utils..bundle_file_name(bundle_name)
+```

data/docs/api/ruby-api.md

@@ -1,3 +1,8 @@
-PENDING:
+# View Helpers
+See the [app/helpers/react_on_rails_helper.rb](../../app/helpers/react_on_rails_helper.rb) source.
 
-Should we document the view helpers here concisely?
+# Controller Helpers
+See the [lib/react_on_rails/controller.rb](../../lib/react_on_rails/controller.rb) source.
+
+# Utility Methods
+See the [lib/react_on_rails/utils.rb](../../lib/react_on_rails/utils.rb) source.

data/docs/tutorial.md

@@ -1,9 +1,6 @@
 # React on Rails Basic Tutorial
 
-* NOTE: Please be sure to use the BETA or RC versions of React on Rails until 9.0 is released.*
-
-
-This tutorial setups up a new Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering. It is updated to 9.0.0.
+This tutorial guides you through setting up a new or existing Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering. It is updated to 10.0.2.
 
 After finishing this tutorial you will get an application that can do the following (live on Heroku):
 
@@ -39,7 +36,7 @@ gem install rails               # download and install latest stable Rails
 gem install foreman             # download and install Foreman
 ```
 
-Then we need to create a fresh Rails application with webpacker react support as following. Be sure that 
+Then we need to create a fresh Rails application with webpacker react support as following.
 
 First be sure to run `rails -v` and check you are using Rails 5.1.3 or above. If you are using an older version of Rails, you'll need to install webpacker with react per the instructions [here](https://github.com/rails/webpacker).
 
@@ -52,23 +49,22 @@ rails new test-react-on-rails --webpack=react
 cd test-react-on-rails
 ```
 
-Note: you can do the following two commands in an existing Rails app or pre Rails 5.1.3:
+Note: if you are installing React On Rails in an existing app or an app that uses Rails pre 5.1.3, you will need to run these two commands as well:
 
 ```
 bundle exec rails webpacker:install
 bundle exec rails webpacker:install:react
 ```
 
-
-
 Add the **React On Rails** gem to your Gemfile:
 
 ```
-gem 'react_on_rails', '9.0.0'         # use latest gem version, prefer exact version 
+gem 'react_on_rails', '10.0.2'         # prefer exact gem version to match npm version
 ```
 
+Note: Latest released React On Rails version is considered stable. Please use the latest version to ensure you get all the security patches and the best support.
 
-Then run `bundle` and commit the git repository (or `rails generate` will not work properly)
+Run `bundle` and commit the git repository (or `rails generate` will not work properly)
 
 
 ```
@@ -80,7 +76,7 @@ git add -A
 git commit -m "Initial commit"
 ```
 
-Install React on Rails: `rails generator react_on_rails:install` or `rails generate react_on_rails:install --redux`. You need to first git commit your files before running the generator, or else it will generate an error.
+Install React on Rails: `rails generate react_on_rails:install` or `rails generate react_on_rails:install --redux`. You need to first git commit your files before running the generator, or else it will generate an error.
 
 ```
 rails generate react_on_rails:install

data/lib/generators/react_on_rails/base_generator.rb

@@ -55,6 +55,8 @@ module ReactOnRails
           if File.exist?(spec_helper)
             add_configure_rspec_to_compile_assets(spec_helper)
           else
+            # rubocop:disable Lint/UnneededDisable
+            # rubocop:disable Layout/EmptyLinesAroundArguments
             GeneratorMessages.add_info(
               <<-MSG.strip_heredoc
 
@@ -67,6 +69,8 @@ module ReactOnRails
               ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
               MSG
             )
+            # rubocop:enable Layout/EmptyLinesAroundArguments
+            # rubocop:enable Lint/UnneededDisable
           end
         end
       end

data/lib/generators/react_on_rails/react_with_redux_generator.rb

@@ -14,7 +14,7 @@ module ReactOnRails
       end
 
       def copy_base_files
-        base_js_path = "base/base"
+        base_js_path = "redux/base"
         base_files = %w[app/javascript/bundles/HelloWorld/components/HelloWorld.jsx]
         base_files.each { |file| copy_file("#{base_js_path}/#{file}", file) }
       end

data/lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.jsx

@@ -13,7 +13,7 @@ export default class HelloWorld extends React.Component {
     super(props);
 
     // How to set initial state in ES6 class syntax
-    // https://facebook.github.io/react/docs/reusable-components.html#es6-classes
+    // https://reactjs.org/docs/state-and-lifecycle.html#adding-local-state-to-a-class
     this.state = { name: this.props.name };
   }
 

data/lib/react_on_rails/assets_precompile.rb

@@ -102,8 +102,8 @@ module ReactOnRails
         next unless File.lstat(filename).symlink?
         begin
           target = File.readlink(filename)
-        rescue # rubocop:disable Lint/RescueWithoutErrorClass
-          puts "React on Rails: Warning: your platform doesn't support File::readlink method." /
+        rescue StandardError
+          puts "React on Rails: Warning: your platform doesn't support File::readlink method." \
                "Skipping broken link check."
           break
         end
@@ -139,7 +139,7 @@ module ReactOnRails
       # pointing to. We can't use File.exist?, as that would check the file pointed at by the symlink.
       File.lstat(path)
       true
-    rescue # rubocop:disable Lint/RescueWithoutErrorClass
+    rescue StandardError
       false
     end
   end

data/lib/react_on_rails/configuration.rb

@@ -62,9 +62,8 @@ module ReactOnRails
     return unless @configuration.webpack_generated_files.empty?
 
     files = ["hello-world-bundle.js"]
-    if @configuration.server_bundle_js_file.present?
-      files << @configuration.server_bundle_js_file
-    end
+    files << @configuration.server_bundle_js_file if @configuration.server_bundle_js_file.present?
+
     @configuration.webpack_generated_files = files
   end
 
@@ -85,7 +84,6 @@ module ReactOnRails
     @configuration ||= Configuration.new(
       node_modules_location: nil,
       generated_assets_dirs: nil,
-
       # generated_assets_dirs is deprecated
       generated_assets_dir: "",
       server_bundle_js_file: "",
@@ -98,7 +96,6 @@ module ReactOnRails
       server_renderer_pool_size: 1,
       server_renderer_timeout: 20,
       skip_display_none: nil,
-
       # skip_display_none is deprecated
       webpack_generated_files: %w[manifest.json],
       rendering_extension: nil,

data/lib/react_on_rails/prerender_error.rb

@@ -6,7 +6,7 @@ module ReactOnRails
     # err might be nil if JS caught the error
     def initialize(component_name: nil, err: nil, props: nil,
                    js_code: nil, console_messages: nil)
-      message = "ERROR in SERVER PRERENDERING\n".dup # rubocop:disable Performance/UnfreezeString
+      message = "ERROR in SERVER PRERENDERING\n".dup
       if err
         # rubocop:disable Layout/IndentHeredoc
         message << <<-MSG

data/lib/react_on_rails/server_rendering_pool.rb

@@ -22,6 +22,7 @@ module ReactOnRails
       def method_missing(sym, *args, &block)
         pool.send sym, *args, &block
       end
+      # rubocop:enable Style/MethodMissing
     end
   end
 end

data/lib/react_on_rails/server_rendering_pool/exec.rb

@@ -98,7 +98,7 @@ module ReactOnRails
           # bundle_js_code = File.read(server_js_file)
           begin
             bundle_js_code = open(server_js_file, &:read)
-          rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+          rescue StandardError
             msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be "\
                 "read. You may set the server_bundle_js_file in your configuration to be \"\" to "\
                 "avoid this warning.\nError is: #{e}"
@@ -115,7 +115,7 @@ module ReactOnRails
           begin
             trace_messsage(base_js_code, file_name)
             ExecJS.compile(base_js_code)
-          rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+          rescue StandardError
             msg = "ERROR when compiling base_js_code! "\
               "See file #{file_name} to "\
               "correlate line numbers of error. Error is\n\n#{e.message}"\

data/lib/react_on_rails/server_rendering_pool/node.rb

@@ -58,9 +58,7 @@ module ReactOnRails
           @js_context_pool.with do |js_context|
             js_context.send(js_code + eof_symbol, 0)
             result = ""
-            while result[-eof_symbol.length..-1] != eof_symbol
-              result += js_context.recv(max_int)
-            end
+            result[-eof_symbol.length..-1] != eof_symbol while result += js_context.recv(max_int)
             result[0..-eof_symbol.length]
           end
         end

data/lib/react_on_rails/utils.rb

@@ -8,6 +8,33 @@ require "active_support/core_ext/string"
 
 module ReactOnRails
   module Utils
+    ###########################################################
+    # PUBLIC API
+    ###########################################################
+
+    # Returns the hashed file name when using webpacker. Useful for creating cache keys.
+    def self.bundle_file_name(bundle_name)
+      raise "Only call bundle_file_name if using webpacker" unless using_webpacker?
+      full_path = bundle_js_file_path_from_webpacker(bundle_name)
+      pathname = Pathname.new(full_path)
+      pathname.basename.to_s
+    end
+
+    # Returns the hashed file name of the server bundle when using webpacker.
+    # Nececessary fragment-caching keys.
+    def self.server_bundle_file_name
+      return @server_bundle_hash if @server_bundle_hash && !Rails.env.development?
+
+      @server_bundle_hash = begin
+        server_bundle_name = ReactOnRails.configuration.server_bundle_js_file
+        bundle_file_name(server_bundle_name)
+      end
+    end
+
+    ###########################################################
+    # PRIVATE API -- Subject to change
+    ###########################################################
+
     # https://forum.shakacode.com/t/yak-of-the-week-ruby-2-4-pathname-empty-changed-to-look-at-file-size/901
     # return object if truthy, else return nil
     def self.truthy_presence(obj)
@@ -85,8 +112,7 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
     end
 
     def self.bundle_js_file_path(bundle_name)
-      if using_webpacker?
-        return bundle_name if bundle_name == "manifest.json"
+      if using_webpacker? && bundle_name != "manifest.json"
         bundle_js_file_path_from_webpacker(bundle_name)
       else
         # Default to the non-hashed name in the specified output directory, which, for legacy
@@ -102,9 +128,7 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
     def self.rails_version_less_than(version)
       @rails_version_less_than ||= {}
 
-      if @rails_version_less_than.key?(version)
-        return @rails_version_less_than[version]
-      end
+      return @rails_version_less_than[version] if @rails_version_less_than.key?(version)
 
       @rails_version_less_than[version] = begin
         Gem::Version.new(Rails.version) < Gem::Version.new(version)

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "10.0.2"
+  VERSION = "10.1.0".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "10.0.2",
+  "version": "10.1.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

data/rakelib/dummy_apps.rake

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "task_helpers"
-include ReactOnRails::TaskHelpers
 
 namespace :dummy_apps do
+  include ReactOnRails::TaskHelpers
+
   task :yarn_install do
     yarn_install_cmd = "yarn install --mutex network"
     sh_in_dir(dummy_app_dir, yarn_install_cmd)

data/rakelib/examples.rake

@@ -8,8 +8,9 @@
 require "yaml"
 require_relative "example_type"
 require_relative "task_helpers"
-include ReactOnRails::TaskHelpers
+
 namespace :examples do # rubocop:disable Metrics/BlockLength
+  include ReactOnRails::TaskHelpers
   # Loads data from examples_config.yml and instantiates corresponding ExampleType objects
   examples_config_file = File.expand_path("../examples_config.yml", __FILE__)
   examples_config = symbolize_keys(YAML.safe_load(File.read(examples_config_file)))

data/rakelib/lint.rake

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "task_helpers"
-include ReactOnRails::TaskHelpers
 
-namespace :lint do
+namespace :lint do # rubocop:disable Metrics/BlockLength
+  include ReactOnRails::TaskHelpers
+
   desc "Run Rubocop as shell"
   task :rubocop do
     sh_in_dir(gem_root, "bundle exec rubocop .")

data/rakelib/node_package.rake

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "task_helpers"
-include ReactOnRails::TaskHelpers
 
 namespace :node_package do
+  include ReactOnRails::TaskHelpers
+
   task :build do
     puts "Building Node Package and running 'yarn link'"
     sh "yarn run build && yarn link"

data/rakelib/release.rake

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "task_helpers"
-include ReactOnRails::TaskHelpers
 require_relative File.join(gem_root, "lib", "react_on_rails", "version_syntax_converter")
 require_relative File.join(gem_root, "lib", "react_on_rails", "git_utils")
 require_relative File.join(gem_root, "lib", "react_on_rails", "utils")
 
+# rubocop:disable Lint/UnneededDisable
+# rubocop:disable Layout/EmptyLinesAroundArguments
 desc("Releases both the gem and node package using the given version.
 
 IMPORTANT: the gem version must be in valid rubygem format (no dashes).
@@ -21,9 +22,13 @@ which are installed via `bundle install` and `yarn`
 2nd argument: Perform a dry run by passing 'true' as a second argument.
 
 Example: `rake release[2.1.0,false]`")
+# rubocop:enable Layout/EmptyLinesAroundArguments
+# rubocop:enable Lint/UnneededDisable
 
 # rubocop:disable Metrics/BlockLength
 task :release, %i[gem_version dry_run tools_install] do |_t, args|
+  include ReactOnRails::TaskHelpers
+
   class MessageHandler
     def add_error(error)
       raise error
@@ -60,9 +65,7 @@ task :release, %i[gem_version dry_run tools_install] do |_t, args|
   sh_in_dir(gem_root, "git add .")
 
   # Will bump the yarn version, commit, tag the commit, push to repo, and release on yarn
-  # rubocop:disable Performance/UnfreezeString
   release_it_command = "$(yarn bin)/release-it --non-interactive --npm.publish".dup
-  # rubocop:enable Performance/UnfreezeString
   release_it_command << " --dry-run --verbose" if is_dry_run
   release_it_command << " #{npm_version}" unless npm_version.strip.empty?
   sh_in_dir(gem_root, release_it_command)
@@ -77,3 +80,4 @@ task :release, %i[gem_version dry_run tools_install] do |_t, args|
     sh_in_dir(gem_root, "git push")
   end
 end
+# rubocop:enable Metrics/BlockLength

data/rakelib/run_rspec.rake

@@ -7,10 +7,10 @@ require "pathname"
 require_relative "task_helpers"
 require_relative "example_type"
 
-include ReactOnRails::TaskHelpers
-
 # rubocop:disable Metrics/BlockLength
 namespace :run_rspec do
+  include ReactOnRails::TaskHelpers
+
   spec_dummy_dir = File.join("spec", "dummy")
 
   desc "Run RSpec for top level only"
@@ -82,6 +82,7 @@ namespace :run_rspec do
     puts "Completed all RSpec tests"
   end
 end
+# rubocop:enable Metrics/BlockLength
 
 desc "js tests (same as 'yarn run test')"
 task :js_tests do
@@ -119,9 +120,7 @@ def run_tests_in(dir, options = {})
 
   command_name = options.fetch(:command_name, path.basename)
   rspec_args = options.fetch(:rspec_args, "")
-  # rubocop:disable Performance/UnfreezeString
   env_vars = "#{options.fetch(:env_vars, '')} TEST_ENV_COMMAND_NAME=\"#{command_name}\"".dup
-  # rubocop:enable Performance/UnfreezeString
   env_vars << "COVERAGE=true" if ENV["USE_COVERALLS"]
   sh_in_dir(path.realpath, "#{env_vars} bundle exec rspec #{rspec_args}")
 end

data/react_on_rails.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 2.0.0"
+  s.required_ruby_version = ">= 2.1.0"
 
   s.add_dependency "addressable"
   s.add_dependency "connection_pool"
@@ -48,3 +48,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec"
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 10.0.2
+  version: 10.1.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -324,6 +324,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dockerfile_tests
 - Gemfile
 - Gemfile.rails32
 - KUDOS.md
@@ -334,10 +335,12 @@ files:
 - SUMMARY.md
 - app/helpers/react_on_rails_helper.rb
 - book.json
+- docker-compose.yml
 - docs/LICENSE.md
 - docs/additional-reading/angular-js-integration-migration.md
 - docs/additional-reading/asset-pipeline.md
 - docs/additional-reading/babel.md
+- docs/additional-reading/caching-and-performance.md
 - docs/additional-reading/code-splitting.md
 - docs/additional-reading/elastic-beanstalk.md
 - docs/additional-reading/foreman-issues.md
@@ -464,7 +467,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -472,7 +475,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Rails with react server rendering with webpack.