react_on_rails 3.0.6 → 4.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5957258eac9feb1ceb153281ac4c4675f51cdf33
-  data.tar.gz: 403c21f1a5e6c898130fcebc552b03a98fe52422
+  metadata.gz: fbaf8ec483e9950e41d61c2e22b62b325113b00a
+  data.tar.gz: 6e2da43df3e19adaffa7ff8a386fd39faa55c4b9
 SHA512:
-  metadata.gz: 814f7d546c1b4f9d76b84f0f5c385599e431724c6b9b1e191e51afb0cbcc0063186559b6f565e282b6f15153a08899744b13c5be42245e593a92e6e00a251efc
-  data.tar.gz: bb9c0eb29e8213664365558ad5a8cf2c006e7dad86e2660174cf53e13666747007d95596b16699fff39a532a8c66c64827e6729e7ec44bcc67eb7c835073310f
+  metadata.gz: 9f716fc038e89ab1f26049d01bc9cfce53717cd40f0705c94a92906aee8f1f340b1b9e1eeb6adddfcf9bb4cc889de3b2638645b7fb78990b543fda4933c80b3c
+  data.tar.gz: 6befd861e58a261de37c42eb332156bd67b125dbbe0823e6d2a42a59b02c0cd8fe4ed5ea49ded2e97d438829d48a206ffe73bd4d03048d6fc595d19fd2d5649d

data/.travis.yml

@@ -12,7 +12,7 @@ gemfile:
   - spec/dummy/Gemfile
 
 env:
-  - export RAILS_ENV=test DRIVER=selenium_chrome
+  - export RAILS_ENV=test DRIVER=selenium
 
 before_install:
   - sudo apt-get update

data/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file. Items under
 Contributors: please follow the recommendations outlined at [keepachangelog.com](http://keepachangelog.com/). Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the `Unreleased` link to compare to the latest release version.
 ## [Unreleased]
 
+## [4.0.0.rc.1] - 2016-03-06
+##### Added
+- Added controller `module ReactOnRails::Controller`. Adds method `redux_store` to setup redux stores in the view.
+- Added view helper `redux_store_hydration_data` to render the props on the application's layout, near the bottom. This allows for the client hydration data to be parsed after the server rendering, which may result in a faster load time.
+- Added helpers `env_stylesheet_link_tag` and `env_javascript_include_tag` to support hot reloading Rails. See the [README.md](./README.md) for more details and see the example application in `spec/dummy`.
+- The checker for outdated bundles before running tests will default to including the directory with `server_bundle_js_file`.
+
+##### Fixed
+- The test runner assets up to date checker might see only the server rendering file, and assume that all assets are up to date.
+- Lots of doc updates!
+- Improved the **spec/dummy** sample app so that it supports CSS modules, hot reloading, etc, and it can server as a template for a new ReactOnRails installation.
+
+##### Breaking Changes
+- Deprecated `redux_store` called from views. Call this method from your controller actions and place `redux_store_hydration_data` on your layout, near the bottom. 
+- Removed the config default of the `config.server_bundle_js_file`. The default is blank, meaning no server rendering.
+
+
 ## [3.0.6] - 2016-03-01
 ##### Fixed
 -	Improved errors when registered store is not found. See [#301](https://github.com/shakacode/react_on_rails/pull/301) by [justin808](https://github.com/justin808).
@@ -192,7 +209,8 @@ Best done with Object destructing:
 
 ##### Fixed
 - Fix several generator related issues.
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/3.0.5...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/3.0.6...master
+[3.0.6]: https://github.com/shakacode/react_on_rails/compare/3.0.5...3.0.6
 [3.0.5]: https://github.com/shakacode/react_on_rails/compare/3.0.4...3.0.5
 [3.0.4]: https://github.com/shakacode/react_on_rails/compare/3.0.3...3.0.4
 [3.0.3]: https://github.com/shakacode/react_on_rails/compare/3.0.2...3.0.3

data/Gemfile

@@ -8,8 +8,6 @@ gemspec
 # bundle install from a single Gemfile. Therefore, all gems that we will need for any dummy/example
 # app have to be manually added to this file.
 gem "bootstrap-sass"
-gem "capybara"
-gem "capybara-screenshot"
 gem "chromedriver-helper"
 gem "coffee-rails", "~> 4.1.0"
 gem "jbuilder", "~> 2.0"
@@ -19,13 +17,11 @@ gem "poltergeist"
 gem "puma"
 gem "rails", "4.2.5"
 gem "rails_12factor"
-gem "rspec-rails"
 gem "rubocop", require: false
 gem "ruby-lint", require: false
 gem "sass-rails", "~> 5.0"
 gem "scss_lint", require: false
 gem "sdoc", "~> 0.4.0", group: :doc
-gem "selenium-webdriver"
 gem "spring"
 gem "sqlite3"
 gem "therubyracer"
@@ -36,3 +32,15 @@ else
 end
 gem "uglifier", ">= 2.7.2"
 gem "web-console", "~> 2.0", group: :development
+
+# below are copied from spec/dummy/Gemfile
+gem "rspec-rails"
+gem "coveralls", require: false
+gem "capybara"
+gem "capybara-screenshot"
+gem "capybara-webkit"
+gem "chromedriver-helper"
+gem "generator_spec"
+gem "launchy"
+gem "poltergeist"
+gem "selenium-webdriver"

data/PROJECTS.md

@@ -7,6 +7,7 @@
 * **[GuavaPass](https://guavapass.com/)**: Coaching client of [ShakaCode](http://www.shakacode.com) and React on Rails fan!
 * **Friends and Guests**, the signature product of [ShakaCode](http://www.shakacode.com), which is a "Social Network Connecting Hosts and Guests". *Coming soon!*
 * **[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/).
+* **[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!
 
 --------
 

data/README.md

@@ -75,7 +75,8 @@ Please see [Getting Started](#getting-started) for how to set up your Rails proj
     - [Client-Side Rendering vs. Server-Side Rendering](#client-side-rendering-vs-server-side-rendering)
     - [Building the Bundles](#building-the-bundles)
     - [Globally Exposing Your React Components](#globally-exposing-your-react-components)
-    - [Rails View Helpers In-Depth](#rails-view-helpers-in-depth)
+    - [ReactOnRails View Helpers API](#reactonrails-view-helpers-api)
+    - [ReactOnRails JavaScript API](#reactonrails-javascript-api)
     - [Redux](#redux)
     - [React-Router](#react-router)
 + [Generator](#generator)
@@ -220,12 +221,12 @@ Place your JavaScript code inside of the provided `client/app` folder. Use modul
 
   In general, you may want different initialization for your server rendered components.
 
-### Rails View Helpers In-Depth
+## ReactOnRails View Helpers API
 Once the bundled files have been generated in your `app/assets/javascripts/generated` folder and you have exposed your components globally, you will want to run your code in your Rails views using the included helper method.
 
 This is how you actually render the React components you exposed to `window` inside of `clientRegistration` (and `global` inside of `serverRegistration` if you are server rendering).
 
-#### react_component
+### react_component
 `react_component(component_name, options = {})`
 
 + **component_name:** Can be a React component, created using a ES6 class, or `React.createClass`, or a generator function that returns a React component.
@@ -238,7 +239,10 @@ This is how you actually render the React components you exposed to `window` ins
   + **raise_on_prerender_error:** Default is false. True will throw an error on the server side rendering. Your controller will have to handle the error.
 + Any other options are passed to the content tag, including the id
 
-#### redux_store
+### redux_store
+#### Controller Extension
+Include the module ReactOnRails::Controller in your controller, probably in ApplicationController. This will provide the following controller method, which you can call in your controller actions:
+
 `redux_store(store_name, props = {})`
 
 + **store_name:** A name for the store. You'll refer to this name in 2 places in your JavaScript:
@@ -246,10 +250,23 @@ This is how you actually render the React components you exposed to `window` ins
   2. In your component definition, you'll call `ReactOnRails.getStore('storeName')` to get the hydrated Redux store to attach to your components.
 + **props:**  ReactOnRails takes care of setting up the hydration of your store with props from the view.
 
-#### Generator Functions
+For an example, see [spec/dummy/app/controllers/pages_controller.rb](spec/dummy/app/controllers/pages_controller.rb).
+
+#### View Helper
+`redux_store_hydration_data`
+
+Place this view helper (no parameters) at the end of your shared layout. This tell ReactOnRails where to client render the redux store hydration data. Since we're going to be setting up the stores in the controllers, we need to know where on the view to put the client side rendering of this hydration data, which is a hidden div with a matching class that contains a data props. For an example, see [spec/dummy/app/views/layouts/application.html.erb](spec/dummy/app/views/layouts/application.html.erb).
+
+#### Redux Store Notes
+Note, you don't need to separately initialize your redux store. However, it's recommended for the two following use cases:
+
+1. You want to have multiple components that access the same store.
+2. You want to place the props to hydrate the client side stores at the very end of your HTML, so the browser can render all earlier HTML first. This is particularly useful if your props will be large.
+
+### Generator Functions
 Why would you create a function that returns a React compnent? For example, you may want the ability to use the passed-in props to initialize a redux store or setup react-router. Or you may want to return different components depending on what's in the props. ReactOnRails will automatically detect a registered generator function.
 
-#### server_render_js
+### server_render_js
 `server_render_js(js_expression, options = {})`
 
 + js_expression, like 2 + 3, and not a block of js code. If you have more than one line that needs to be executed, wrap it in an [IIFE](https://en.wikipedia.org/wiki/Immediately-invoked_function_expression). JS exceptions will be caught and console messages handled properly
@@ -257,8 +274,93 @@ Why would you create a function that returns a React compnent? For example, you
 
 This is a helper method that takes any JavaScript expression and returns the output from evaluating it. If you have more than one line that needs to be executed, wrap it in an IIFE. JS exceptions will be caught and console messages handled properly.
 
+## ReactOnRails JavaScript API
+The best source of docs is the main [ReactOnRails.js](node_package/src/ReactOnRails.js) file. Here's a quick summary. No guarantees that this won't be outdated!
+
+```js
+  /**
+   * Main entry point to using the react-on-rails npm package. This is how Rails will be able to
+   * find you components for rendering.
+   * @param components (key is component name, value is component)
+   */
+  register(components)
+
+  /**
+   * Allows registration of store generators to be used by multiple react components on one Rails
+   * view. store generators are functions that take one arg, props, and return a store. Note that
+   * the setStore API is different in tha it's the actual store hydrated with props.
+   * @param stores (key is store name, value is the store generator)
+   */
+  registerStore(stores)
+
+  /**
+   * Allows retrieval of the store by name. This store will be hydrated by any Rails form props. 
+   * Pass optional param throwIfMissing = false if you want to use this call to get back null if the
+   * store with name is not registered.
+   * @param name
+   * @param throwIfMissing Defaults to true. Set to false to have this call return undefined if 
+   *        there is no store with the given name.
+   * @returns Redux Store, possibly hydrated
+   */
+  getStore(name, throwIfMissing = true )
+
+  /**
+   * Set options for ReactOnRails, typically before you call ReactOnRails.register
+   * Available Options:
+   * `traceTurbolinks: true|false Gives you debugging messages on Turbolinks events
+   */
+  setOptions(options)
+```
+
+## Hot Reloading View Helpers
+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 the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/) for a working example.
+
+The key options are `static` and `hot` which specify what you want for static vs. hot. Both of these params are optional, and support either a single value, or an array.
+
+static vs. hot is picked based on whether ENV["REACT_ON_RAILS_ENV"] == "HOT"
+
+```erb
+ <%= env_stylesheet_link_tag(static: 'application_static',
+                             hot: 'application_non_webpack',
+                             media: 'all',
+                             'data-turbolinks-track' => true)  %>
+
+ <!-- These do not use turbolinks, so no data-turbolinks-track -->
+ <!-- This is to load the hot assets. -->
+ <%= env_javascript_include_tag(hot: ['http://localhost:3500/vendor-bundle.js',
+                                      'http://localhost:3500/app-bundle.js']) %>
+
+ <!-- These do use turbolinks -->
+ <%= env_javascript_include_tag(static: 'application_static',
+                                hot: 'application_non_webpack',
+                                'data-turbolinks-track' => true) %>
+```
+                                
+See application.html.erb for usage example and [application.html.erb](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/app%2Fviews%2Flayouts%2Fapplication.html.erb)
+
+**env_javascript_include_tag(args = {})**
+
+Helper to set CSS assets depending on if we want static or "hot", which means from the Webpack dev server.
+
+In this example, application_non_webpack is simply a CSS asset pipeline file which includes styles not placed in the webpack build.
+
+We don't need styles from the webpack build, as those will come via the JavaScript include tags.
+
+The key options are `static` and `hot` which specify what you want for static vs. hot. Both of
+these params are optional, and support either a single value, or an array.
+
+```erb
+ <%= env_stylesheet_link_tag(static: 'application_static',
+                             hot: 'application_non_webpack',
+                             media: 'all',
+                             'data-turbolinks-track' => true)  %>
+```
+
+**env_stylesheet_link_tag(args = {})**
+
+
 ## Generator
-The `react_on_rails:install` generator combined with the example pull requests of generator runs will get you up and running efficiently. There's a fair bit of setup with integrating Webpack with Rails. Defaults for options are such that the default is for the flag to be off. For example, the default for `-R` is that `redux` is off, and the default of `-b` means that `skip-bootstrap` is off.
+The `react_on_rails:install` generator combined with the example pull requests of generator runs will get you up and running efficiently. There's a fair bit of setup with integrating Webpack with Rails. Defaults for options are such that the default is for the flag to be off. For example, the default for `-R` is that `redux` is off, and the default of `-b` is that `skip-bootstrap` is off.
 
 Run `rails generate react_on_rails:install --help` for descriptions of all available options:
 
@@ -380,7 +482,7 @@ Bootstrap integration is enabled by default, but can be disabled by passing the
 The React on Rails generator can add linters and their recommended accompanying configurations to your project. There are two classes of linters: ruby linters and JavaScript linters.
 
 ##### JavaScript Linters
-JavaScript linters are **enabled by default**, but can be disabled by passing the `--skip-js-linters` flag (alias `j`) , and those that run in Node have been add to `client/package.json` under `devDependencies`.
+JavaScript linters are **enabled by default**, but can be disabled by passing the `--skip-js-linters` flag (alias `j`) , and those that run in Node have been added to `client/package.json` under `devDependencies`.
 
 ##### Ruby Linters
 Ruby linters are **disabled by default**, but can be enabled by passing the `--ruby-linters` flag when generating. These linters have been added to your Gemfile in addition to the appropriate Rake tasks.

data/app/helpers/react_on_rails_helper.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Metrics/ModuleLength
 # NOTE:
 # For any heredoc JS:
 # 1. The white spacing in this file matters!
@@ -5,6 +6,57 @@
 require "react_on_rails/prerender_error"
 
 module ReactOnRailsHelper
+  # 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
+  # https://github.com/shakacode/react-webpack-rails-tutorial/ for a working example.
+  #
+  # The key options are `static` and `hot` which specify what you want for static vs. hot. Both of
+  # these params are optional, and support either a single value, or an array.
+  #
+  # static vs. hot is picked based on whether
+  # ENV["REACT_ON_RAILS_ENV"] == "HOT"
+  #
+  #   <%= env_stylesheet_link_tag(static: 'application_static',
+  #                               hot: 'application_non_webpack',
+  #                               media: 'all',
+  #                               'data-turbolinks-track' => true)  %>
+  #
+  #   <!-- These do not use turbolinks, so no data-turbolinks-track -->
+  #   <!-- This is to load the hot assets. -->
+  #   <%= env_javascript_include_tag(hot: ['http://localhost:3500/vendor-bundle.js',
+  #                                        'http://localhost:3500/app-bundle.js']) %>
+  #
+  #   <!-- These do use turbolinks -->
+  #   <%= env_javascript_include_tag(static: 'application_static',
+  #                                  hot: 'application_non_webpack',
+  #                                  'data-turbolinks-track' => true) %>
+  # See application.html.erb for usage example
+  # https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/app%2Fviews%2Flayouts%2Fapplication.html.erb
+  def env_javascript_include_tag(args = {})
+    send_tag_method(:javascript_include_tag, args)
+  end
+
+  # Helper to set CSS assets depending on if we want static or "hot", which means from the
+  # Webpack dev server.
+  #
+  # In this example, application_non_webpack is simply a CSS asset pipeline file which includes
+  # styles not placed in the webpack build.
+  #
+  # We don't need styles from the webpack build, as those will come via the JavaScript include
+  # tags.
+  #
+  # The key options are `static` and `hot` which specify what you want for static vs. hot. Both of
+  # these params are optional, and support either a single value, or an array.
+  #
+  #   <%= env_stylesheet_link_tag(static: 'application_static',
+  #                               hot: 'application_non_webpack',
+  #                               media: 'all',
+  #                               'data-turbolinks-track' => true)  %>
+  #
+  def env_stylesheet_link_tag(args = {})
+    send_tag_method(:stylesheet_link_tag, args)
+  end
+
   # react_component_name: can be a React component, created using a ES6 class, or
   #   React.createClass, or a
   #    `generator function` that returns a React component
@@ -89,28 +141,41 @@ module ReactOnRailsHelper
     # IMPORTANT: Ensure that we mark string as html_safe to avoid escaping.
     <<-HTML.html_safe
 #{component_specification_tag}
-#{rendered_output}
-#{replay_console(options) ? console_script : ''}
+    #{rendered_output}
+    #{replay_console(options) ? console_script : ''}
     HTML
   end
 
+  # Deprecated: Use `redux_store` via including ReactOnRails::Controller in your controller and calling
+  # redux_store.
+  #
   # Separate initialization of store from react_component allows multiple react_component calls to
   # use the same Redux store.
   #
   # store_name: name of the store, corresponding to your call to ReactOnRails.registerStores in your
   #             JavaScript code.
-  # props: Ruby Hash or JSON string which contains the properties to pass to the redux storea.
+  # props: Ruby Hash or JSON string which contains the properties to pass to the redux store.
   def redux_store(store_name, props = {})
+    warn "[DEPRECATION] `redux_store` within a view is deprecated. Please move to call "\
+      "to redux store to your controller action."
     redux_store_data = { store_name: store_name,
                          props: props }
     @registered_stores ||= []
     @registered_stores << redux_store_data
 
-    content_tag(:div,
-                "",
-                class: "js-react-on-rails-store",
-                style: ReactOnRails.configuration.skip_display_none ? nil : "display:none",
-                data: redux_store_data)
+    render_redux_store_data(redux_store_data)
+  end
+
+  # Place this view helper (no parameters) at the end of your shared layout. This tell
+  # ReactOnRails where to client render the redux store hydration data. Since we're going
+  # to be setting up the stores in the controllers, we need to know where on the view to put the
+  # client side rendering of this hydration data, which is a hidden div with a matching class
+  # that contains a data props.
+  def redux_store_hydration_data
+    return if @registered_stores_via_controller.blank?
+    @registered_stores_via_controller.reduce("") do |accum, redux_store_data|
+      accum << render_redux_store_data(redux_store_data)
+    end.html_safe
   end
 
   def sanitized_props_string(props)
@@ -165,6 +230,14 @@ module ReactOnRailsHelper
 
   private
 
+  def render_redux_store_data(redux_store_data)
+    content_tag(:div,
+                "",
+                class: "js-react-on-rails-store",
+                style: ReactOnRails.configuration.skip_display_none ? nil : "display:none",
+                data: redux_store_data)
+  end
+
   def next_react_component_index
     @react_component_index ||= -1
     @react_component_index += 1
@@ -206,12 +279,12 @@ module ReactOnRailsHelper
     if result["hasErrors"] && raise_on_prerender_error(options)
       # We caught this exception on our backtrace handler
       # rubocop:disable Style/RaiseArgs
-      fail ReactOnRails::PrerenderError.new(component_name: react_component_name,
-                                            # Sanitize as this might be browser logged
-                                            props: sanitized_props_string(props),
-                                            err: nil,
-                                            js_code: wrapper_js,
-                                            console_messages: result["consoleReplayScript"])
+      raise ReactOnRails::PrerenderError.new(component_name: react_component_name,
+                                             # Sanitize as this might be browser logged
+                                             props: sanitized_props_string(props),
+                                             err: nil,
+                                             js_code: wrapper_js,
+                                             console_messages: result["consoleReplayScript"])
       # rubocop:enable Style/RaiseArgs
     end
     result
@@ -227,9 +300,12 @@ module ReactOnRailsHelper
   end
 
   def initialize_redux_stores
-    return "" unless @registered_stores.present?
+    return "" unless @registered_stores.present? || @registered_stores_via_controller.present?
     declarations = "var reduxProps, store, storeGenerator;\n"
-    result = @registered_stores.each_with_object(declarations) do |redux_store_data, memo|
+
+    all_stores = (@registered_stores || []) + (@registered_stores_via_controller || [])
+
+    result = all_stores.each_with_object(declarations) do |redux_store_data, memo|
       store_name = redux_store_data[:store_name]
       props = props_string(redux_store_data[:props])
       memo << <<-JS
@@ -290,4 +366,15 @@ ReactOnRails.setStore('#{store_name}', store);
     end
     [final_options, props]
   end
+
+  def use_hot_reloading?
+    ENV["REACT_ON_RAILS_ENV"] == "HOT"
+  end
+
+  def send_tag_method(tag_method_name, args)
+    asset_type = use_hot_reloading? ? :hot : :static
+    assets = Array(args[asset_type])
+    options = args.delete_if { |key, _value| %i(hot static).include?(key) }
+    send(tag_method_name, *assets, options) unless assets.empty?
+  end
 end

data/docs/additional_reading/heroku_deployment.md

@@ -18,9 +18,9 @@ Assuming you have downloaded and installed the Heroku command-line utility and h
 heroku buildpacks:set https://github.com/heroku/heroku-buildpack-multi
 ```
 
-Heroku will now be able to use the multiple buildpacks specified in `.buildpacks`. 
+Heroku will now be able to use the multiple buildpacks specified in `.buildpacks`.
 
-Note, an alternative approach is to use the [Heroku Toolbelt to set buildpacks](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app).
+For more information, see [Using Multiple Buildpacks for an App](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app)
 
 ## Fresh Rails Install
 

data/docs/additional_reading/hot-reloading-rails-development.md

@@ -0,0 +1,32 @@
+# Hot Reloading of Assets For Rails Development
+
+This document outlines the steps to setup your React On Rails Environment so that you can experience the pleasure of hot reloading of JavaScript and Sass during your Rails development work. There are 2 examples of this setup:
+1. [spec/dummy](../spec/dummy): Simpler setup used for integration testing this gem.
+1. [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). Full featured setup using Twitter bootstrap.
+
+## High Level Strategy
+
+We'll use a Webpack Dev server on port 3500 to provide the assets to Rails, rather than the asset pipeline, and only during development mode. This is configured via the `Procfile.hot`. 
+
+`Procfile.static` provides an alternative that uses "static" assets, similar to a production deployment.
+
+The secret sauce is in the [app/views/layouts/application.html.erb](spec/dummy/app/views/layouts/application.html.erb) where it uses view helpes to configure the correct assets to load, being either the "hot" assets or the "static" assets.
+
+## Places to Configure (Files to Examine)
+
+1. See the Webpack config files. Note, these examples are now setup for using [CSS Modules](https://github.com/css-modules/css-modules).
+   1. [client/webpack.client.base.config.js](spec/dummy/client/webpack.client.base.config.js): Common configuration for hot or static assets.
+   1. [client/webpack.client.hot.config.js](spec/dummy/client/webpack.client.hot.config.js): Setup for hot loading, using react-transform-hmr.
+   1. [client/webpack.client.static.config.js](spec/dummy/client/webpack.client.static.config.js): Setup for static loading, as is done in a production deployment.
+1. [app/views/layouts/application.html.erb](spec/dummy/app/views/layouts/application.html.erb): Uses the view helpers `env_stylesheet_link_tag` and `env_javascript_include_tag` which will either do the hot reloading or the static loading.
+1. See the Procfiles: [Procfile.hot](spec/dummy/Procfile.hot) and [Procfile.static](spec/dummy/Procfile.static). These:
+   1. Start the webpack processes, depending on the mode or HOT or not.
+   2. Start the rails server, setting an ENV value of REACT_ON_RAILS_ENV to HOT if we're hot loading or else setting this to blank.
+1. Configure the file Rails asset pipeline files:
+   1. [app/assets/javascripts/application_static.js.erb](spec/dummy/app/assets/javascripts/application_static.js.erb): We have to only specify the `vendor-bundle` and `app-bundle` if we're not HOT loading, as Sprockets will throw an error if that is the case. Note the use of `require_asset`.
+   1. [app/assets/stylesheets/application_static.js.erb](spec/dummy/app/assets/stylesheets/application_static.scss.erb): We have to only specify the `vendor-bundle` and `app-bundle` if we're not HOT loading, as Sprockets will throw an error if that is the case. Note the conditional around the @import.
+1. Be sure your [config/initializers/assets.rb](spec/dummy/config/initializers/assets.rb) is configured to include the webpack generated files.
+1. Copy the [client/server-rails-hot.js](spec/dummy/client/server-rails-hot.js) to the [client](client) directory.
+1. Copy the scripts in the top level and client level `package.json` files:
+   1. Top Level: [package.json](spec/dummy/package.json)
+   1. Client Level: [package.json](spec/dummy/client/package.json)

data/lib/generators/USAGE

@@ -2,9 +2,9 @@ Description:
 
 The react_on_rails:install generator combined with the example pull requests of
 generator runs will get you up and running efficiently. There's a fair bit of
-setup involved when ~with~ integrating Webpack with Rails. Defaults for options
+setup involved when integrating Webpack with Rails. Defaults for options
 are such that the default is for the flag to be off. For example, the default for
-`-R` is that redux is off, and the default of -b means that skip-bootstrap is off.
+`-R` is that redux is off, and the default of -b is that skip-bootstrap is off.
 
 * Redux
 
@@ -83,7 +83,7 @@ are such that the default is for the flag to be off. For example, the default fo
 * JavaScript Linters
 
     JavaScript linters are enabled by default, but can be disabled by passing the
-    --skip-js-linters flag (alias j), and those that run in Node have been add to
+    --skip-js-linters flag (alias j), and those that run in Node have been added to
     `client/package.json` under devDependencies.
 
 * Ruby Linters

data/lib/react_on_rails.rb

@@ -1,5 +1,6 @@
 require "rails"
 
+require "react_on_rails/controller"
 require "react_on_rails/version"
 require "react_on_rails/version_checker"
 require "react_on_rails/configuration"

data/lib/react_on_rails/configuration.rb

@@ -4,14 +4,13 @@ module ReactOnRails
   end
 
   DEFAULT_GENERATED_ASSETS_DIRS = [
-    %w(app assets javascripts generated),
-    %w(app assets javascripts stylesheets generated)
+    %w(app assets webpack)
   ].map { |dirs| File.join(*dirs) }.freeze
 
   def self.configuration
     @configuration ||= Configuration.new(
       generated_assets_dirs: DEFAULT_GENERATED_ASSETS_DIRS,
-      server_bundle_js_file: File.join(*%w(app assets javascripts generated server.js)),
+      server_bundle_js_file: "",
       prerender: false,
       replay_console: true,
       logging_on_server: true,

data/lib/react_on_rails/controller.rb

@@ -0,0 +1,19 @@
+module ReactOnRails
+  module Controller
+    # Separate initialization of store from react_component allows multiple react_component calls to
+    # use the same Redux store.
+    #
+    # store_name: name of the store, corresponding to your call to ReactOnRails.registerStores in your
+    #             JavaScript code.
+    # props: Ruby Hash or JSON string which contains the properties to pass to the redux store.
+    #
+    # Be sure to include view helper `redux_store_hydration_data` at the end of your layout or view
+    # or else there will be no client side hydration of your stores.
+    def redux_store(store_name, props)
+      redux_store_data = { store_name: store_name,
+                           props: props }
+      @registered_stores_via_controller ||= []
+      @registered_stores_via_controller << redux_store_data
+    end
+  end
+end

data/lib/react_on_rails/test_helper.rb

@@ -38,20 +38,39 @@ module ReactOnRails
     #                         defaults to ReactOnRails::TestHelper::WebpackProcessChecker
     # webpack_assets_compiler: provide one method: `def compile`
     #                         defaults to ReactOnRails::TestHelper::WebpackAssetsCompiler
+    # server_bundle_js_file: The server rendering file, defaulting to server_bundle_js_file in
+    #                        your config
     # client_dir and compiled_dirs are passed into the default webpack_assets_status_checker if you
     #                         don't provide one.
     def self.ensure_assets_compiled(webpack_assets_status_checker: nil,
-                                    webpack_assets_compiler: nil,
-                                    webpack_process_checker: nil,
-                                    client_dir: nil,
-                                    compiled_dirs: nil)
+      webpack_assets_compiler: nil,
+      webpack_process_checker: nil,
+      client_dir: nil,
+      compiled_dirs: nil,
+      server_bundle_js_file: nil)
 
       if webpack_assets_status_checker.nil?
         client_dir ||= Rails.root.join("client")
         compiled_dirs ||= ReactOnRails.configuration.generated_assets_dirs
+        server_bundle_js_file ||= ReactOnRails.configuration.server_bundle_js_file
+
+        if server_bundle_js_file.present?
+          dir = File.dirname(server_bundle_js_file)
+          compiled_dirs ||= []
+          compiled_dirs << dir unless compiled_dirs.include?(dir)
+        end
         webpack_assets_status_checker ||=
           WebpackAssetsStatusChecker.new(client_dir: client_dir,
-                                         compiled_dirs: compiled_dirs)
+                                         compiled_dirs: compiled_dirs,
+                                         server_bundle_js_file: server_bundle_js_file)
+
+        unless @printed_once
+          puts
+          puts "====> React On Rails: Checking dirs for outdated/missing bundles: "\
+            "#{webpack_assets_status_checker.compiled_dirs}"
+          puts
+          @printed_once = true
+        end
       end
 
       webpack_assets_compiler ||= WebpackAssetsCompiler.new

data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb

@@ -53,8 +53,11 @@ module ReactOnRails
       def puts_max_iterations_message(loop_count)
         if loop_count == MAX_TIME_TO_WAIT
           stale_files = webpack_assets_status_checker.whats_not_up_to_date.join("\n")
-
-          puts <<-MSG
+          if stale_files.empty?
+            puts "Please check your config value for `config.generated_assets_dirs`."
+            puts "We're not finding your generated files for test runs."
+          else
+            puts <<-MSG
 
 Even though we detected the webpack watch processes are running, we found files modified that are
 not causing a rebuild of your generated files:
@@ -66,6 +69,7 @@ your webpack files: #{webpack_assets_status_checker.client_dir}
 
 To be sure, we will now rebuild your generated files.
           MSG
+          end
         end
       end
     end

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -24,7 +24,7 @@ https://github.com/shakacode/react_on_rails/blob/master/docs/additional_reading/
 
         build_output = `cd client && npm run build:#{type}`
 
-        fail "Error in building assets!\n#{build_output}" unless Utils.last_process_completed_successfully?
+        raise "Error in building assets!\n#{build_output}" unless Utils.last_process_completed_successfully?
 
         puts "Completed building Webpack #{type}-rendering assets."
       end

data/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb

@@ -6,16 +6,16 @@ require "fileutils"
 module ReactOnRails
   module TestHelper
     class WebpackAssetsStatusChecker
-      attr_reader :client_dir, :compiled_dirs
+      attr_reader :client_dir, :compiled_dirs, :server_bundle_js_file
 
       def initialize(args = {})
         @compiled_dirs = args.fetch(:compiled_dirs)
         @client_dir = args.fetch(:client_dir)
+        @server_bundle_js_file = args.fetch(:server_bundle_js_file)
         @last_stale_files = ""
       end
 
       def up_to_date?
-        # binding.pry
         return false unless assets_exist?
         all_compiled_assets.all? do |asset|
           FileUtils.uptodate?(asset, client_files)
@@ -46,7 +46,11 @@ module ReactOnRails
       end
 
       def all_compiled_assets
-        make_file_list(make_globs(compiled_dirs)).to_ary
+        file_list = make_file_list(make_globs(compiled_dirs)).to_ary
+        if file_list && !file_list.empty?
+          file_list.delete(server_bundle_js_file)
+        end
+        file_list
       end
 
       def client_files
@@ -58,12 +62,12 @@ module ReactOnRails
       end
 
       def assets_exist?
-        all_compiled_assets.to_ary.size > 0
+        !all_compiled_assets.empty?
       end
 
       def make_file_list(glob)
         FileList.new(glob) do |fl|
-          fl.exclude(%r{/node_modules/})
+          fl.exclude(%r{/node_modules})
           fl.exclude(".DS_Store")
           fl.exclude(".keep")
           fl.exclude("thumbs.db")

data/lib/react_on_rails/test_helper/webpack_process_checker.rb

@@ -22,7 +22,7 @@ module ReactOnRails
       # We only want to do this if server rendering is enabled.
       def fail_if_only_running_for_one_type(client_running, server_running)
         return unless client_running ^ server_running
-        fail "\n\nError: detected webpack is not running for both types of assets:\n"\
+        raise "\n\nError: detected webpack is not running for both types of assets:\n"\
          "***Webpack Client Process Running?: #{client_running}\n"\
          "***Webpack Server Process Running?: #{server_running}"
       end

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "3.0.6".freeze
+  VERSION = "4.0.0.beta.1".freeze
 end

data/package.json

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

data/rakelib/release.rake

@@ -32,7 +32,6 @@ task :release, [:gem_version, :dry_run, :tools_install] do |_t, args|
   args_hash = args.to_hash
 
   is_dry_run = ReactOnRails::Utils.object_to_boolean(args_hash[:dry_run])
-  should_install_tools = ReactOnRails::Utils.object_to_boolean(args_hash.fetch(:tools_install, true))
 
   gem_version = args_hash.fetch(:gem_version, "")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 4.0.0.beta.1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -319,6 +319,7 @@ files:
 - docs/LICENSE
 - docs/additional_reading/babel.md
 - docs/additional_reading/heroku_deployment.md
+- docs/additional_reading/hot-reloading-rails-development.md
 - docs/additional_reading/manual_installation.md
 - docs/additional_reading/node_dependencies_and_npm.md
 - docs/additional_reading/optional_configuration.md
@@ -409,6 +410,7 @@ files:
 - lib/generators/react_on_rails/templates/ruby_linters/ruby-lint.yml.tt
 - lib/react_on_rails.rb
 - lib/react_on_rails/configuration.rb
+- lib/react_on_rails/controller.rb
 - lib/react_on_rails/engine.rb
 - lib/react_on_rails/git_utils.rb
 - lib/react_on_rails/prerender_error.rb
@@ -455,9 +457,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8