react_rails_webpack 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b8bc9dfe64d4a32d2062a74cb8d6ac5df0c36a6
-  data.tar.gz: c89be03dc8ba0d35bab2f5592cfef8353895e965
+  metadata.gz: 3d2ecda0dd8a3b414e1343d24bd2d36ccc709554
+  data.tar.gz: 7314e2c8775d7374bc0e7dbf9326310ba93e052d
 SHA512:
-  metadata.gz: 6b29c24883e39b76fa9d57212a0e8fefb0984ce711be9d582b27c8125edbf502db9dfdfe3fc70e12cdf1132fcff46cdd5180c413516ad2982f1562e0a55f80c1
-  data.tar.gz: 8061632235edb8b2de4638b574bf271a165f5e53692acd31e47650c46e121407fa04f729224ed9e6c4e0c4817c717c4860fc30c9d67841975ce64cb510b59187
+  metadata.gz: cfda64f15b88c0352f9e93302c06ae886200661fc6f0d0c91f2678d240f0f3cf46cd6e12af1e8a452cb9fab6bcddc2ad48bab67530c2e4dbe2ee24fc66bade28
+  data.tar.gz: 9cd597258ea42a24ad273f9285937e804fd1c65b6c5eae09b539975eec9d040eb0a30f7993aa47eaac783cd5a09633129782170d8d2ad6c63425a5dbe4feaa6b

data/README.md

@@ -1,13 +1,13 @@
 # ReactRailsWebpack
 
-Ruby gem for quickly and easily creating highly customizable react/rails integrations using webpack and npm. Has built-in examples of plain and redux-backed React components with ES6/7, JSX, and hot-reloading.
+Ruby gem for quickly and easily creating highly customizable react/rails integrations using webpack and npm.
 
 ## Key Features
 
 1. One-command setup
-2. Use any packages from the npm ecosystem
-3. Automatically sets up working demo examples so you can jump into React immediately
-4. The webpack development server for React components will live update your changes to any device on your local network (including phones)
+2. Use any packages from the [npm](https://www.npmjs.com) ecosystem
+3. Built-in examples of plain and [redux](http://redux.js.org)-backed React components
+4. The [webpack](https://webpack.github.io) development server for React components will live update your changes to any device on your local network (including phones)
 
 ## Install
 
@@ -22,6 +22,54 @@ Ruby gem for quickly and easily creating highly customizable react/rails integra
 - **[node](https://nodejs.org)** version **4 or greater** (check version with `node -v`)
 - **[npm](https://www.npmjs.com/)** version **3 or greater** (check version with `npm -v`)
 
+## Contents
+
+- **[Key features](#key-features)**
+- **[Install](#install)**
+- **[Requirements](#requirements)**
+- **[About](#about)**
+  - [Pros](#pros)
+  - [Cons](#cons)
+- **[See the demo components in action](#see-the-demo-components-in-action)**
+  - [On webpack dev server](#on-webpack-dev-server)
+  - [On your Rails app](#on-your-rails-app)
+- **[Commands](#commands)**
+  - [To set up the integration](#set-up-the-integration)
+  - [To set up an example page in your Rails app](#set-up-an-example-page-in-your-rails-app)
+  - [To configure a new clone of your repo](#configure-react_rails_webpack-on-a-new-clone-of-your-repo)
+  - [To see the url of your webpack development server](#see-the-url-of-your-webpack-development-server)
+  - [Integrate with Trailblazer](#generate-react-component-trailblazer-cell)
+- **[Suggested development workflow](#suggested-development-workflow)**
+- **[Creating and using your own components](#creating-and-using-your-own-components)**
+- **[How does this work?](#how-does-this-work)**
+- **[Gotchas](#gotchas)**
+  - [Forgetting to run npm run build](#forgetting-to-run-npm-run-build)
+  - [Forgetting to add components to the availableComponents file](#forgetting-to-add-components-to-the-clientsrcappavailablecomponentsjs-file)
+  - [Forgetting to run rails g react_rails_webpack:new_fork when cloning your repo on a new machine](#forgetting-to-run-rails-g-react_rails_webpacknew_fork-when-cloning-your-repo-on-a-new-machine)
+  - [npm install vs. npm run install](#npm-install-vs-npm-run-install)
+- **[Development](#development)**
+- **[Contributing](#contributing)**
+- **[License](#license)**
+
+## About
+
+When I looked over the available gems for react/rails integrations, none of them were as customizable as I wanted, so I decided to build my own. Since I wanted it to be as customizable as possible, I made my gem a set of generators, instead of a bunch of under-the-hood gem code. You can customize the inner workings of this integration to your heart's content, since all the files used for the integration will be added directly to your app. You can edit them, delete them, and add or remove any npm packages you like, because this integration allows you to use any npm packages you could use in a static front-end react app.
+
+### Pros:
+
+- [Webpack](https://webpack.github.io/) integration
+- Hot-reloading webpack development server
+- Ability to see dev server output on any computer (or mobile device) on your network
+- Built-in [redux](http://redux.js.org/) integration
+- Generators provide example code for basic react components and react-redux components
+- Highly customizable
+- Ability to use any [npm](https://www.npmjs.com/) packages that you could use on a static front-end app
+
+### Cons:
+
+- This gem does not do server-side rendering. I don't find this makes much of a difference for my apps in practice, but if it does for you, best avoid. [This post by Henrik Joreteg](https://blog.andyet.com/2015/05/18/lazymorphic-apps-bringing-back-static-web) covers some of the reasons I like just doing it this way.
+
+
 ## See the demo components in action
 
 ### On webpack dev server
@@ -65,7 +113,7 @@ This command will tell you the url of your webpack development server on your lo
 
 `rails g react_rails_webpack:trailblazer_integration`
 
-If you use the Trailblazer gem, use this command to add a [trailblazer](https://github.com/apotonick/trailblazer) cell for react components to your `lib` folder.
+If you use [the Trailblazer gem](https://github.com/apotonick/trailblazer), use this command to add a trailblazer cell for react components to your `lib` folder.
 
 ## Suggested Development Workflow
 
@@ -76,24 +124,6 @@ If you use the Trailblazer gem, use this command to add a [trailblazer](https://
 5. Add calls to the `react_component` helper method in your Rails app to render your React components in views
 6. Make sure they still work, repeat steps 1-5 until satisfied
 
-## About
-
-When I looked over the available gems for react/rails integrations, none of them were as customizable as I wanted, so I decided to build my own. Since I wanted it to be as customizable as possible, I made my gem a set of generators, instead of a bunch of under-the-hood gem code. You can customize the inner workings of this integration to your heart's content, since all the files used for the integration will be added directly to your app. You can edit them, delete them, and add or remove any npm packages you like, because this integration allows you to use any npm packages you could use in a static front-end react app.
-
-### Pros:
-
-- [Webpack](https://webpack.github.io/) integration
-- Hot-reloading webpack development server
-- Ability to see dev server output on any computer (or mobile device) on your network
-- Built-in [redux](http://redux.js.org/) integration
-- Generators provide example code for basic react components and react-redux components
-- Highly customizable
-- Ability to use any [npm](https://www.npmjs.com/) packages that you could use on a static front-end app
-
-### Cons:
-
-- This gem does not do server-side rendering, so if you need to do SEO stuff within your react components, it's probably the wrong choice
-
 ## Creating and using your own components
 
 Let's say you want to make a checkout form component with react. Here's what you'd need to do to use it from Rails:
@@ -180,7 +210,7 @@ export default {
 
 If it looked like that, you would render your `MyComponent` React component with `react_component :ComponentName`, and you would render your `SomeOtherComponent` React component with `react_component :OtherName`. Using `react_component :MyComponent` would NOT work. The `react_component` method is looking for the javascript object keys from [availableComponents.js](lib/react_rails_webpack/client/src/app/availableComponents.js) (e.g. `ComponentName`, `OtherName` ), NOT the actual component class names (e.g. `MyComponent`, `SomeOtherComponent`). It's usually fine to make the object key the same as the class name, though. They're just different in this example for clarity.
 
-Assuming `react_component` finds a key in [availableComponents.js](lib/react_rails_webpack/client/src/app/availableComponents.js) that matches the what it's given, it will immediately render that component within that div, passing in props from the `data-componentprops` attribute. As the page loads, each successive div generated by `react_component` renders this way.
+Assuming `react_component` finds a key in [availableComponents.js](lib/react_rails_webpack/client/src/app/availableComponents.js) that matches the name it's given, it will immediately render that component within that div, passing in props from the `data-componentprops` attribute. As the page loads, each successive div generated by `react_component` renders this way.
 
 ## Gotchas
 

data/lib/react_rails_webpack/client/src/app/renderingComponentsInDivs.js

@@ -6,7 +6,7 @@ import wrapWithProvider from './wrapWithProvider'
 // Used in findAndCreateComponent
 import components from './availableComponents'
 
-// This function gets called by the react_rails_webpack Rails helper
+// This function gets called by the react_rails_webpack Rails helper.
 // It renders the specified component in the div from which the
 // function is called.
 export function renderLastComponentDiv () {
@@ -21,16 +21,17 @@ export function renderReactComponentInDiv (targetDiv) {
 
   ReactDOM.render(
     findAndCreateComponent(componentName, componentProps),
-    targetDiv)
+    targetDiv
+  )
 }
 
 function findAndCreateComponent (componentName, props) {
   const component = components[componentName]
+  const element = React.createElement(component.class, props)
 
   if (component.redux) {
-    const element = React.createElement(component.class, props)
     return wrapWithProvider(element)
   } else {
-    return React.createElement(component.class, props)
+    return element
   }
 }

data/lib/react_rails_webpack/version.rb

@@ -1,3 +1,3 @@
 module ReactRailsWebpack
-  VERSION = "2.0.7"
+  VERSION = "2.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_rails_webpack
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Neurodynamic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails