react_rails_webpack 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c189456f50861b52bdb07739afce550cbb2b078a
-  data.tar.gz: 63fdbed97a9edc51789f136c2bd7e1b883b79bfd
+  metadata.gz: 195d4ed6a5da6fb44246c755535be02aa38eccd3
+  data.tar.gz: 316c5a00aec3b4894739637884cc94939499ae77
 SHA512:
-  metadata.gz: 05eb488af3291d896b840f7a36462311ae1508da41cc42646c34c2537ee460745de6ecca167681c0af5ef1f9fbc01f148a94d5ba88a9581e5044aec7560a2c6c
-  data.tar.gz: 376c419af4f100e235b278de9891ee3d6ad141e4260d33186ab9ea4ad268e3d2da6e5b2666a3cfc5279dbee4ba81b3fd20e2e792eace275c9d29f2d31b95229a
+  metadata.gz: 9e481e80ac9f68dc57120a38a2d0065b3abab6c6a7df8e5138d05a3b7fb38fbe4ee89674a8e7b6a98f275704060fc828da3e6f9334db2c3898fe136c6f5155e2
+  data.tar.gz: 891a05c9e757fbb2a2c84a1f495ca4ec763d5bc2e7f5ab453084965d5022adcdf38c6a2e58284d055394c9422d7c51b3abf31a4e11d95c19da868e3f4afe4966

data/.gitignore

@@ -7,4 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-/lib/react_rails_webpack/client/node_modules
+/lib/react_rails_webpack/client/node_modules
+.flooignore
+.floo

data/README.md

@@ -1,6 +1,12 @@
 # ReactRailsWebpack
 
-A set of Rails generators that create all the necessary boilerplate code for integrating React, Webpack, and Redux libraries into Rails 4.0+ apps.
+A set of Rails generators that create all the necessary boilerplate code (with examples) for integrating React, Webpack, and Redux libraries into Rails 4.0+ apps.
+
+## Key Features
+
+1. Use any packages from the npm ecosystem
+2. Automatically setup working demo examples so you can jump into React immediately
+3. Development server for React components will live update your changes to any device on your local network (including phones)
 
 ## Quick Start
 
@@ -12,7 +18,6 @@ A set of Rails generators that create all the necessary boilerplate code for int
 4. Run `rails g react_rails_webpack:install` ([further explanation of what this does](#generating-the-integration))
 5. Run `npm run install`
 6. Run `npm run build`
-7. Set the dev server hostname ([instructions](#setting-the-dev-server-hostname))
 
 ### Add example page
 
@@ -22,11 +27,12 @@ A set of Rails generators that create all the necessary boilerplate code for int
 
 ### Suggested Development Workflow
 
-1. Write and test new components by running the webpack dev server with the command `npm run start` (note: the base html page for the webpack dev server is based on the html provided to `context.defaultTemplate` in [the webpack.config.js file](lib/react_rails_webpack/client/webpack.config.js))
-2. Add any components you want to spin up with the `react_component` helper in Rails to [the available components file](lib/react_rails_webpack/client/src/app/availableComponents.js) ([further explanation](#creating-and-using-your-own-components))
-3. Run the `npm run build` command to compile your javascript files and add them to the Rails assets folder
-4. Add calls to the `react_component` helper method in your Rails app to render your React components in views
-5. Make sure they still work, repeat steps 1-5 until satisfied
+1. Write the code for your React components in the [client/src/components](lib/react_rails_webpack/client/src/components) directory
+2. Test your new components with live reloading by running the webpack dev server with the command `npm run start` (note: the base html page for the webpack dev server is based on the html provided to `context.defaultTemplate` in [the webpack.config.js file](lib/react_rails_webpack/client/webpack.config.js))
+3. Add any components you want to spin up with the `react_component` helper in Rails to [the available components file](lib/react_rails_webpack/client/src/app/availableComponents.js) ([further explanation](#creating-and-using-your-own-components))
+4. Run the `npm run build` command to compile your javascript files and add them to the Rails assets folder
+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
 
@@ -34,13 +40,13 @@ When I looked over the available gems for react/rails integrations, none of them
 
 ### Pros:
 
-- Webpack integration
+- [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 integration
+- 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 packages that you could use on a static front-end app
+- Ability to use any [npm](https://www.npmjs.com/) packages that you could use on a static front-end app
 
 ### Cons:
 
@@ -58,15 +64,11 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install react_rails_webpack
-
 ## Requirements
 
 - [Rails](http://rubyonrails.org/) 4.0+
-- [node](https://nodejs.org/) (tested on 4.2.2)
-- [npm](https://www.npmjs.com/) (tested on 3.4.0)
+- [node](https://nodejs.org/) (tested on 4.2.2 and 5.4.1)
+- [npm](https://www.npmjs.com/) (tested on 3.4.0 and 3.5.3)
 
 ## Generating the Integration
 
@@ -83,23 +85,13 @@ This will setup a basic react integration with some example components (one stan
 
 Then set the dev server hostname ([instructions](#setting-the-dev-server-hostname)).
 
-## Setting the dev server hostname
-
-Then go to [the client/environment.json file](lib/react_rails_webpack/client/environment.json) and fill in your computer's network name. If you're using a Mac, to find out what your computer's network name is, you can go to `System Preferences`, and then the `Sharing` menu, and you should see it in the `Computer Name` field. `environment.json` should end up looking something like this:
-
-```
-{
-  "hostname": "my_mac.local"
-}
-```
-
 ## Generating an Example Page
 
 If you want to setup an example page in your Rails app that uses the provided React components, run:
 
     $ rails g react_rails_webpack:create_example_page
 
-Then run the rails server and go to [the greeting page](localhost:3000/greeting) to see everything in action.
+Then run the rails server and go to [the greeting page](http://localhost:3000/greeting) to see everything in action.
 
 ## Creating and using your own components
 
@@ -150,7 +142,7 @@ Will add a [trailblazer](https://github.com/apotonick/trailblazer) cell for reac
 
 ## Working with the Webpack Dev Server
 
-`npm run start` will start a webpack development server with hot reloading that is completely independent of your Rails app. You can see the output of this server on any computer or mobile device on your local network by going to `hostname:3000` (replace `hostname` with whatever you set it to in the `hostname.json` file).
+`npm run start` will start a webpack development server with hot reloading that is completely independent of your Rails app. You can see the output of this server on any computer or mobile device on your local network by going to `computer-name.local:3000` (replace `computer-name.local` with [whatever you set hostname to](#setting-the-dev-server-hostname) in the `environment.json` file).
 
 ## Gotchas
 

data/lib/react_rails_webpack/client/environment.json

@@ -1,3 +1,3 @@
 {
-  "hostname": "YOUR_COMPUTERS_NAME_ON_YOUR_NETWORK.local"
+  "hostname": "<<<LOCALHOST_NAME>>>.local"
 }

data/lib/react_rails_webpack/install_generator.rb

@@ -32,6 +32,13 @@ module ReactRailsWebpack
       end
     end
 
+    def set_environment_hostname
+      localhost_name = `scutil --get LocalHostName`.strip
+      puts "Setting localhost name to #{localhost_name}..."
+
+      gsub_file 'client/environment.json', /<<<LOCALHOST_NAME>>>/, localhost_name
+    end
+
     def add_webpack_asset_inclusion
       puts 'Adding asset includes...'
       # Add webpack folder to application asset paths
@@ -69,8 +76,6 @@ module ReactRailsWebpack
       puts
       puts "Done! Now #{"make sure you have node and npm installed".red.bold}, and then #{"run the".red.bold} #{"npm run install".white.bold} #{"and".red.bold} #{"npm run build".white.bold} #{"commands".red.bold} to finish setting up."
       puts
-      puts "Also, #{"don't forget to set your hostname".red.bold} in the #{"client/environment.json".white.bold} file. Instructions for this can be found here: #{"https://github.com/neurodynamic/react_rails_webpack#setting-the-dev-server-hostname".blue}"
-      puts
       puts "-" * `tput cols`.to_i # print line of dashes
       puts
     end

data/lib/react_rails_webpack/version.rb

@@ -1,3 +1,3 @@
 module ReactRailsWebpack
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

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