react_on_rails 4.0.3 → 5.0.0.rc.1

data/package.json

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 5.0.0.rc.1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -318,31 +318,30 @@ files:
 - app/helpers/react_on_rails_helper.rb
 - docker-compose.yml
 - 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
-- docs/additional_reading/rails_view_rendering_from_inline_javascript.md
-- docs/additional_reading/react-and-redux.md
-- docs/additional_reading/react_router.md
-- docs/additional_reading/rspec_configuration.md
-- docs/additional_reading/server_rendering_tips.md
-- docs/additional_reading/tips.md
-- docs/additional_reading/turbolinks.md
-- docs/additional_reading/updating-dependencies.md
-- docs/additional_reading/webpack.md
-- docs/code_of_conduct.md
+- docs/additional-reading/babel.md
+- docs/additional-reading/heroku-deployment.md
+- docs/additional-reading/hot-reloading-rails-development.md
+- docs/additional-reading/installation-overview.md
+- docs/additional-reading/node-dependencies-and-npm.md
+- docs/additional-reading/rails_view_rendering_from_inline_javascript.md
+- docs/additional-reading/react-and-redux.md
+- docs/additional-reading/react-router.md
+- docs/additional-reading/recommended-project-structure.md
+- docs/additional-reading/rspec-configuration.md
+- docs/additional-reading/server-rendering-tips.md
+- docs/additional-reading/tips.md
+- docs/additional-reading/turbolinks.md
+- docs/additional-reading/updating-dependencies.md
+- docs/additional-reading/webpack.md
 - docs/coding-style/linters.md
 - docs/coding-style/style.md
-- docs/contributing.md
-- docs/doctrine.md
-- docs/generator_testing.md
-- docs/rails3.md
-- docs/recommended-project-structure.md
-- docs/releasing.md
-- docs/tutorial-v2.md
+- docs/contributor-info/contributing.md
+- docs/contributor-info/generator-testing.md
+- docs/contributor-info/releasing.md
+- docs/misc/code_of_conduct.md
+- docs/misc/doctrine.md
+- docs/misc/rails3.md
+- docs/tutorial.md
 - lib/generators/USAGE
 - lib/generators/react_on_rails/base_generator.rb
 - lib/generators/react_on_rails/bootstrap_generator.rb
@@ -457,9 +456,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.6.1

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

@@ -1,32 +0,0 @@
-# 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/docs/additional_reading/manual_installation.md

@@ -1,117 +0,0 @@
-# TODO FIX THIS FILE AFTER this is updated: https://github.com/shakacode/react-webpack-rails-tutorial
-
-# Manual Installation
-Follow these steps if you choose to forgo the generator:
-
-1. Globally expose React in your webpack config like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/webpack.client.base.config.js#L31):
-
-  ```javascript
-  module: {
-    loaders: [
-      // React is necessary for the client rendering:
-      { test: require.resolve('react'), loader: 'expose?React' },
-
-      // For React 0.14
-      { test: require.resolve('react-dom'), loader: 'expose?ReactDOM' }, // not in the server one
-  ```
-
-
-3. Expose your client globals like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/app/startup/clientRegistration.jsx#L3):
-
-  ```javascript
-  import App from './ClientApp';
-  import ReactOnRails from 'react-on-rails';
-  ReactOnRails.register({ App });
-  ```
-4. Put your client globals file as webpack entry points like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/webpack.client.rails.config.js#L22). Similar pattern for server rendering.
-
-  ```javascript
-  config.entry.app.push('./app/startup/clientRegistration');
-  ```
-
-## Additional Steps For Server Rendering (option `prerender` shown below)
-See the next section for a sample webpack.server.rails.config.js.
-
-1. Expose your server globals like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/app/startup/serverRegistration.jsx#L7)
-
-  ```javascript
-  import App from './ServerApp';
-  global.App = App;
-  ```
-2. Make the server globals file an entry point in your webpack config, like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/webpack.server.rails.config.js#L7)
-
-  ```javascript
-  entry: ['./app/startup/serverRegistration'],
-  ```
-3. Ensure the name of your ouput file (shown [here](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/webpack.server.rails.config.js#L9)) of your server bundle corresponds to the configuration of the gem. The default path is `app/assets/webpack`. See below for customization of configuration variables.
-4. Expose `React` in your webpack config, like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.server.rails.build.config.js#L54-L55)
-
-```javascript
-{ test: require.resolve('react'), loader: 'expose?React' },
-
-// For React 0.14
-{ test: require.resolve('react-dom/server'), loader: 'expose?ReactDOMServer' }, // not in client one, only server
-```
-### Sample webpack.server.rails.build.config.js (ONLY for server rendering)
-Be sure to check out the latest example version of [client/webpack.server.rails.build.config.js](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.server.rails.build.config.js).
-
-```javascript
-// Common webpack configuration for server bundle
-
-module.exports = {
-
-  // the project dir
-  context: __dirname,
-  entry: ['./app/startup/serverRegistration'],
-  output: {
-    filename: 'server-bundle.js',
-    path: '../app/assets/webpack',
-
-    // CRITICAL to set libraryTarget: 'this' for enabling Rails to find the exposed modules IF you
-    //   use the "expose" webpackfunctionality. See startup/serverRegistration.jsx.
-    // NOTE: This is NOT necessary if you use the syntax of global.MyComponent = MyComponent syntax.
-    // See http://webpack.github.io/docs/configuration.html#externals for documentation of this option
-    //libraryTarget: 'this',
-  },
-  resolve: {
-    extensions: ['', '.js', '.jsx'],
-  },
-  module: {
-    loaders: [
-      {test: /\.jsx?$/, loader: 'babel-loader', exclude: /node_modules/},
-
-      // React is necessary for the client rendering:
-      { test: require.resolve('react'), loader: 'expose?React' },
-      { test: require.resolve('react-dom/server'), loader: 'expose?ReactDOMServer' },
-    ],
-  },
-};
-```
-
-## What Happens?
-
-Here's what the browser will render with a call to the `react_component` helper.
-![2015-09-28_20-24-35](https://cloud.githubusercontent.com/assets/1118459/10157268/41435186-6624-11e5-9341-6fc4cf35ee90.png)
-
-  If you're curious as to what the gem generates for the server and client rendering, see [`spec/dummy/client/app/startup/serverRegistration.jsx`](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/spec/sample_generated_js/server-generated.js)
-  and [`spec/dummy/client/app/startup/ClientReduxApp.jsx`](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/spec/sample_generated_js/client-generated.js) for examples of this. Note, this is not the code that you are providing. You can see the client code by viewing the page source.
-
-* **props**: [hash | string of json] Properties to pass to the react object. See this example if you're using Jbuilder: [react-webpack-rails-tutorial view rendering props using jBuilder](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/app/views/pages/index.html.erb#L20)
-
-```erb
-<%= react_component('App', render(template: "/comments/index.json.jbuilder"), prerender: true) %>
-```
-* **options:** [hash]
-  * **prerender**: <true/false> set to false when debugging!
-  * **trace**: <true/false> set to true to print additional debugging information in the browser default is true for development, off otherwise
-  * **replay_console**: <true/false> Default is true. False will disable echoing server rendering logs, which can make troubleshooting server rendering difficult.
-  * Any other options are passed to the content tag, including the id.
-
-# JavaScript
-
-1. Configure your webpack configuration to create the file used for server rendering if you plan to do server rendering.
-2. Follow the examples in `spec/dummy/client/app/startup/clientRegistration.jsx` to expose your react components for client side rendering.
-3. Follow the examples in `spec/dummy/client/app/startup/serverRegistration.jsx` to expose your react components for server side rendering. The code is the same, but you might be importing from a file specialized for server rendering.
-
-## React 0.13 vs. React 0.14
-We no longer support React 0.13.

data/docs/additional_reading/optional_configuration.md

@@ -1,33 +0,0 @@
-# Optional Configuration
-
-Create a file `config/react_on_rails.rb` to override any defaults (this file is automatically created for you when using the generator). If you don't specify this file, the default options are below.
-
-The `server_bundle_js_file` must correspond to the bundle you want to use for server rendering.
-
-```ruby
-# Shown below are the defaults for configuration
-ReactOnRails.configure do |config|
-  # Client bundles are configured in application.js
-  # Server bundle is a single file for all server rendering of components.
-  # Set the server_bundle_js_file to "" if you know that you will not be server rendering.
-  config.server_bundle_js_file = "server-bundle.js" # This is the default
-
-  # Below options can be overriden by passing to the helper method.
-  config.prerender = false # default is false
-  config.trace = Rails.env.development? # default is true for development, off otherwise
-
-  # For server rendering. This can be set to false so that server side messages are discarded.
-  config.replay_console = true # Default is true. Be cautious about turning this off.
-  config.logging_on_server = true # Default is true. Logs server rendering messags to Rails.logger.info
-
-  # Settings for the pool of renderers:
-  config.server_renderer_pool_size  ||= 1  # ExecJS doesn't allow more than one on MRI
-  config.server_renderer_timeout    ||= 20 # seconds
-end
-```
-
-You can configure your pool of JS virtual machines and specify where it should load code:
-
-- On MRI, use `therubyracer` for the best performance (see [discussion](https://github.com/reactjs/react-rails/pull/290))
-- On MRI, you'll get a deadlock with `pool_size` > 1
-- If you're using JRuby, you can increase `pool_size` to have real multi-threaded rendering.