react_on_rails 1.2.2 → 2.0.0.beta.1

data/docker-compose.yml

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

data/docs/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Justin Gordon
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/docs/additional_reading/heroku_deployment.md

@@ -1,23 +0,0 @@
-# Heroku Deployment
-The generator has created the necessary files and gems for deployment to Heroku. If you have installed manually, you will need to provide these files yourself:
-
-+ `Procfile`: used by Heroku and Foreman to start the Puma server
-+ `.buildpacks`: used to install Ruby and Node environments
-+ `12factor` gem: required by Heroku
-+ `'puma'` gem: recommended Heroku webserver
-+ `config/puma.rb`: Puma webserver config file
-+ `lib/tasks/assets.rake`: This rake task file is provided by the generator regardless of whether the user chose Heroku Deployment as an option. It is highlighted here because it is helpful to understand that this task is what generates your JavaScript bundles in production.
-
-## How to Deploy
-
-React on Rails requires both a ruby environment (for Rails) and a Node environment (for Webpack), so you will need to have Heroku use multiple buildpacks. Currently, we would suggest using [DDollar's Heroku Buildpack Multi](https://github.com/ddollar/heroku-buildpack-multi).
-
-Assuming you have downloaded and installed the Heroku command-line utility and have initialized the app, you will need to tell Heroku to use Heroku Buildpack Multi via the command-line:
-
-```
-heroku buildpacks:set https://github.com/heroku/heroku-buildpack-multi
-```
-
-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).

data/docs/additional_reading/manual_installation.md

@@ -1,142 +0,0 @@
-# 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
-  ```
-
-
-2. Require `react_on_rails` in your `application.js` like  [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/361f4338ebb39a5d3934b00cb6d6fcf494773000/app/assets/javascripts/application.js#L15). It possibly should come after you require `turbolinks`:
-
-  ```
-  //= require react_on_rails
-  ```
-3. Expose your client globals like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/app/startup/clientGlobals.jsx#L3):
-
-  ```javascript
-  import App from './ClientApp';
-  window.App = 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/clientGlobals');
-  ```
-
-## 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/serverGlobals.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/serverGlobals'],
-  ```
-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/javascripts/generated`. 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/serverGlobals'],
-  output: {
-    filename: 'server-bundle.js',
-    path: '../app/assets/javascripts/generated',
-
-    // CRITICAL to set libraryTarget: 'this' for enabling Rails to find the exposed modules IF you
-    //   use the "expose" webpackfunctionality. See startup/serverGlobals.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: ['', '.webpack.js', '.web.js', '.js', '.jsx', 'config.js'],
-  },
-  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/serverGlobals.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"),
-    generator_function: true, prerender: true) %>
-```
-* **options:** [hash]
-  * **generator_function**: <true/false> default is false, set to true if you want to use a generator function rather than a React Component.
-  * **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/clientGlobals.jsx` to expose your react components for client side rendering.
-
-  ```ruby
-  import HelloWorld from '../components/HelloWorld';
-  window.HelloWorld = HelloWorld;
-  ```
-3. Follow the examples in `spec/dummy/client/app/startup/serverGlobals.jsx` to expose your react components for server side rendering.
-
-  ```ruby
-  import HelloWorld from '../components/HelloWorld';
-  global.HelloWorld = HelloWorld;
-  ```
-
-## React 0.13 vs. React 0.14
-The main difference for using react_on_rails is that you need to add additional lines in the webpack config files:
-
-+ Normal mode (JavaScript is rendered on the client side) webpack config file:
-
-  ```javascript
-  { test: require.resolve('react-dom'), loader: 'expose?ReactDOM' },
-  ```
-+ Server-side rendering webpack config file:
-
-  ```javascript
-  { test: require.resolve('react-dom/server'), loader: 'expose?ReactDOMServer' },
-  ```

data/docs/additional_reading/node_dependencies_and_npm.md

@@ -1,29 +0,0 @@
-# Node Dependencies and NPM
-## Updating
-After installing the files, you may want to update the node dependencies. This is analogous to updating gem versions:
-
-```bash
-cd client
-npm install -g npm-check-updates
-rm npm-shrinkwrap.json
-npm-check-updates -u
-npm install
-npm prune
-npm shrinkwrap
-```
-
-Confirm that the hot replacement dev server and the Rails server both work. You may have to delete `node_modules` and `npm-shrinkwrap.json` and then run `npm shrinkwrap`.
-
-*Note: `npm prune` is required before running `npm shrinkwrap` to remove dependencies that are no longer needed after doing updates.*
-
-## Adding New Dependencies
-Typically, you can add your Node dependencies as you normally would. Occasionally, adding a new dependency may require removing and re-running `npm shrinkwrap`:
-
-```bash
-cd client
-npm install --save module_name@version
-# or
-# npm install --save_dev module_name@version
-rm npm-shrinkwrap.json
-npm shrinkwrap
-```

data/docs/additional_reading/optional_configuration.md

@@ -1,34 +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 = "app/assets/javascripts/generated/server.js" # This is the default
-
-  # Below options can be overriden by passing to the helper method.
-  config.prerender = false # default is false
-  config.generator_function = false # default is false, meaning that you expose ReactComponents directly
-  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.

data/docs/additional_reading/react-and-redux.md

@@ -1,36 +0,0 @@
-# Communication between React Components and Redux Reducers
-
-## Communication Between Components
-See https://facebook.github.io/react/tips/communicate-between-components.html
-
-# Redux Reducers
-Documentation of generated Redux code for reducers.
-
-## Example
-The `helloWorld/reducers/index.jsx` example that results from running the generator with the Redux option may be slightly confusing because of its simplicity. For clarity, what follows is a more fleshed-out example of what a reducer might look like:
-
-```javascript
-import usersReducer from './usersReducer';
-import blogPostsReducer from './blogPostsReducer';
-import commentsReducer from './commentsReducer';
-// ...
-
-import { $$initialState as $$usersState } from './usersReducer';
-import { $$initialState as $$blogPostsState } from './blogPostsReducer';
-import { $$initialState as $$commentsState } from './commentsReducer';
-// ...
-
-export default {
-  $$usersStore: usersReducer,
-  $$blogPostsStore: blogPostsReducer,
-  $$commentsStore: commentsReducer,
-  // ...
-};
-
-export const initalStates = {
-  $$usersState,
-  $$blogPostsState,
-  $$commentsState,
-  // ...
-};
-```

data/docs/additional_reading/react_router.md

@@ -1,45 +0,0 @@
-# Using React Router
-React on Rails supports the use of React Router. Client-side code doesn't need any special configuration for the React on Rails gem. Implement React Router how you normally would.
-
-However, when attempting to use server-rendering, it is necessary to take steps that prevent rendering when there is a router error or redirect. In these cases, the client code should return an object containing the `error` and a `redirectLocation` instead of the React component. The `react_component` helper method in your Rails view will automatically detect that there was an error/redirect and handle it accordingly.
-
-If you are working with the HelloWorldApp created by the react_on_rails generator, then the code below corresponds to the module in `client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx`.
-
-```js
-const RouterApp = (props, location) => {
-  const store = createStore(props);
-
-  let error;
-  let redirectLocation;
-  let routeProps;
-
-  // See https://github.com/rackt/react-router/blob/master/docs/guides/advanced/ServerRendering.md
-  match({ routes, location }, (_error, _redirectLocation, _routeProps) => {
-    error = _error;
-    redirectLocation = _redirectLocation;
-    routeProps = _routeProps;
-  });
-
-  // This tell react_on_rails to skip server rendering any HTML. Note, client rendering
-  // will handle the redirect. What's key is that we don't try to render.
-  // Critical to return the Object properties to match this { error, redirectLocation }
-  if (error || redirectLocation) {
-    return { error, redirectLocation };
-  }
-
-  // Important that you don't do this if you are redirecting or have an error.
-  return (
-    <Provider store={store}>
-      <RoutingContext {...routeProps} />
-    </Provider>
-  );
-};
-```
-
-For a fleshed out integration of react_on_rails with react-router, check out [React Webpack Rails Tutorial Code](https://github.com/shakacode/react-webpack-rails-tutorial), specifically the files:
-
-* [react-webpack-rails-tutorial/client/app/bundles/comments/routes/routes.jsx](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/routes/routes.jsx)
-
-* [react-webpack-rails-tutorial/client/app/bundles/comments/startup/ClientRouterApp.jsx](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/startup/ClientRouterApp.jsx)
-
-* [react-webpack-rails-tutorial/client/app/bundles/comments/startup/ServerRouterApp.jsx](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/startup/ServerRouterApp.jsx)

data/docs/additional_reading/server_rendering_tips.md

@@ -1,16 +0,0 @@
-# Server Rendering Tips
-
-- Your code can't reference `document`. Server side JS execution does not have access to `document`, so jQuery and some
-  other libs won't work in this environment. You can debug this by putting in `console.log`
-  statements in your code.
-- You can conditionally avoid running code that references document by passing in a boolean prop to your top level react
-  component. Since the passed in props Hash from the view helper applies to client and server side code, the best way to
-  do this is to use a generator function.
-- If you're serious about server rendering, it's worth the effort to have different entry points for client and server rendering. It's worth the extra complexity.
-
-You might also do something like this in some file for your top level component:
-```javascript
-global.App = () => <MyComponent serverSide={true} />;
-```
-
-The point is that you have separate files for top level client or server side, and you pass some extra option indicating that rendering is happening server sie.

data/docs/additional_reading/tips.md

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

data/docs/additional_reading/webpack.md

@@ -1,46 +0,0 @@
-# Entry Points and Globally Exposing Objects
-
-You should ensure you configure the entry points correctly for webpack.
-
-## When using React 0.14 and greater
-
-You need both include `react-dom/server` and `react` as values for `entry`, like this:
-
-```
-  entry: {
-
-    // See use of 'vendor' in the CommonsChunkPlugin inclusion below.
-    vendor: [
-      'babel-core/polyfill',
-      'jquery',
-      'jquery-ujs',
-      'react',
-      'react-dom',
-    ],
-```
-
-and you need to expose them:
-
-```
-      // React is necessary for the client rendering:
-      {test: require.resolve('react'), loader: 'expose?React'},
-      {test: require.resolve('react-dom'), loader: 'expose?ReactDOM'},
-      {test: require.resolve('jquery'), loader: 'expose?jQuery'},
-      {test: require.resolve('jquery'), loader: 'expose?$'},
-```
-
-`webpack.server.config.js` is similar, but substitute:
-
-```
- entry: ['./yourCode', 'react-dom/server', 'react'],
-```
-
-and use this line rather than `{test: require.resolve('react-dom'), loader: 'expose?ReactDOM'},`:
-
-```
-   {test: require.resolve('react-dom/server'), loader: 'expose?ReactDOMServer'},
-```
-
-## When you use React 0.13
-
-You don't need to put in react-dom.

data/docs/code_of_conduct.md

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

data/docs/coding-style/linters.md

@@ -1,64 +0,0 @@
-# Linters
-These linters support the [ShakaCode Style Guidelines](./style.md)
-
-## Autofix!
-
-If you haven't tried the autofix options for `jscs` and `rubocop`, you're seriously missing out!
-
-1. Be **SURE** you have a clean git status, as you'll want to review what the autofix does to your code!
-2. **Rubocop:**  Be sure to be in the right directory where you have Ruby files, probably the top level of your Rails project.
-  ```
-  rubocop -a
-  ```
-
-3. **JSCS:**: Be sure to be in the right directory where you have JS files.
-  ```
-  jscs -x .
-  ```
-
-Autofixing is a **HUGE** time saver!
-
-## ESLint
-
-### Configuring Rules
-
-Rules are configured with a 0, 1 or 2. Setting a rule to 0 is turning it off, setting it to 1 triggers a warning if that rule is violated, and setting it to 2 triggers an error.
-
-Rules can also take a few additional options. In this case, the rule can be set to an array, the first item of which is the 0/1/2 flag and the rest are options.
-
-See file [.eslintrc](../../client/.eslintrc) for examples of configuration
-
-### Specify/Override rules in code
-
-Rules can also be specified in the code file to be linted, as JavaScript comments. This can be useful when the rule is a one-off or is a override to a project-wide rule.
-
-For example, if your file assumes a few globals and you have the no-undef rule set in the .eslintrc file, you might want to relax the rule in the current file.
-
-```
-/* global $, window, angular */
-// rest of code
-```
-
-It's also useful to disable ESLint for particular lines or blocks of lines.
-
-```
-console.log('console.log not allowed'); // eslint-disable-line
-
-alert('alert not allowed'); // eslint-disable-line no-alert
-
-/* eslint-disable no-console, no-alert */
-console.log('more console.log');
-alert('more alert');
-/* eslint-enable no-console, no-alert */
-```
-
-You can disable all rules for a line or block, or only specific rules, as shown above.
-
-### Useful Reference Links
-
-* [Configuring ESLint](http://eslint.org/docs/user-guide/configuring.html#configuring-rules)
-* [ESLint quick start](http://untilfalse.com/eslint-quick-start/)
-* [RuboCop][https://github.com/bbatsov/rubocop]
-* [ESLint][http://eslint.org/] 
-* [JSCS][https://github.com/jscs-dev/node-jscs]
-