react_on_rails 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5ca55badb6ceca9925da1de262b446c426c3136
-  data.tar.gz: 7759b5eb04038825848f76b951f894a9112609d7
+  metadata.gz: c2f1692d27068c5ff56f536cb757df449c45f24b
+  data.tar.gz: 318551a2d916e05290e9016c3b6b711e5626df6c
 SHA512:
-  metadata.gz: 27a7c6c0571f9bf5ac2633b5c668cd91eda08a4c8ede17a13b8e34c404fd8a4dd9f86689864e5ccef3fb7dbb8802e95e5aeedede49a655dad6e0e461437d7ed2
-  data.tar.gz: bdd6e4ce1686febd1b91b21a98f3cc0c3fe8cf2f637bd5d7ece41e2d9017e20b33a718e89e5a4bc763b219e3d566f761a5811651e8a54f5f91395bd771779ba1
+  metadata.gz: bccce7baf521f616d7e3114e4ec3a1ce76d838c2079255ae842f17190c92b732a664f72bff6fc750b8751bbfd8e482ace93573c5b61d84767a8c4c376cbcdc80
+  data.tar.gz: cd5e62885e22cf3f30e3402f65dc2e4d1d25adbeb9e1a941848821e73315c9ccd2408e8de4f8c49d45d25c3ed145611b6cbfc097222c2f2cff7b0aa89d66811c

data/CHANGELOG.md

@@ -5,50 +5,51 @@ All notable changes to this project will be documented in this file. Items under
 - Move JavaScript part of react_on_rails to npm package 'react-on-rails'.
 - Converted JavaScript code to ES6! with tests!
 - No global namespace pollution. ReactOnRails is the only global added.
-- New API. Instead of placing React components on the global namespace, you instead call ReactOnRails.register, passing an object where keys are the names of your components.
-  ```
+- New API. Instead of placing React components on the global namespace, you instead call ReactOnRails.register, passing an object where keys are the names of your components:
+```
+import ReactOnRails from 'react-on-rails';
+ReactOnRails.register({name: component});
+```
+Best done with Object destructing:
+```
   import ReactOnRails from 'react-on-rails';
-  ReactOnRails.registerComponent({name: component});
-  ```
-  Best done with Object destructing
-  ```
-  import ReactOnRails from 'react-on-rails';
-  ReactOnRails.registerComponent(
+  ReactOnRails.register(
     {
       Component1,
       Component2
     }
   );
-  ```
-  Previously, you used 
+```
+  Previously, you used
   ```
   window.Component1 = Component1;
   window.Component2 = Component2;
   ```
   This would pollute the global namespace. See details in the README.md for more information.
 - Your jade template for the WebpackDevServer setup should use the new API:
-  ```
+```
   ReactOnRails.render(componentName, props, domNodeId);
-  ```
+```
   such as:
-  ```
+```
   ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app');
-  ```
+```
 - All npm dependency libraries updated. Most notable is going to Babel 6.
 - Dropped support for react 0.13.
-- JS Linter uses ShakaCode JavaScript style: https://github.com/shakacode/style-guide-javascript 
+- JS Linter uses ShakaCode JavaScript style: https://github.com/shakacode/style-guide-javascript
 - Generators account these differences.
 
 ### Migration Steps
 [Example of upgrading](https://github.com/shakacode/react-webpack-rails-tutorial/commit/5b1b8698e8daf0f0b94e987740bc85ee237ef608)
 
-1. Update the `react_on_rails` gem
-2. Search you app for 'generator_function' and remove lines in layouts and rb files that contain it. Determination of a generator function is handled automatically.
-3. Find your files where you registered client and server globals, and use the new ReactOnRails.register syntax. Optionally rename the files `clientRegistration.jsx` and `serverRegistration.jsx` rather than `Globals`.
-4. Update your index.jade to use the new API `ReactOnRails.render("MyApp", !{props}, 'app');`
-5. Update your webpack files per the example commit. Remove globally exposing React and ReactDom, as well as their inclusion in the `entry` section. These are automatically included now.
-
-That's it!
+1. Update the `react_on_rails` gem.
+2. Remove `//= require react_on_rails` from any files such as `app/assets/javascripts/application.js`. This file comes from npm now.
+3. Search you app for 'generator_function' and remove lines in layouts and rb files that contain it. Determination of a generator function is handled automatically.
+4. Find your files where you registered client and server globals, and use the new ReactOnRails.register syntax. Optionally rename the files `clientRegistration.jsx` and `serverRegistration.jsx` rather than `Globals`.
+5. Update your index.jade to use the new API `ReactOnRails.render("MyApp", !{props}, 'app');`
+6. Update your webpack files per the example commit. Remove globally exposing React and ReactDom, as well as their inclusion in the `entry` section. These are automatically included now.
+7. Run `cd client && npm i --save react-on-rails` to get react-on-rails into your `client/package.json`.
+8. You should also update any other dependencies if possible to match up with the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/).
 
 ## v1.2.2
 ### Fixed

data/README.md

@@ -2,10 +2,13 @@
 
 # NEWS
 
-* 2.0 has shipped! Please grab the latest and let us know if you see any issues!
-* It does not yet have *generator* support for CSS modules and hot reloading via the Rails server per shown in the [shakacode/react-webpack-rails-tutorial]. We're always looking for contributors! Thus, the setup for webpack, foreman, and sass will be somewhat different until we get the generators caught up.
+* 2.0 has shipped! Please grab the latest and let us know if you see any issues! [Migration steps from 1.x](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#migration-steps).
+* It does not yet have *generator* support for building new apps that use CSS modules and hot reloading via the Rails server as is demonstrated in the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). *We do support this, but we don't generate the code.* If you did generate a fresh app from react_on_rails and want to move to CSS Modules, then see [PR 175: Babel 6 / CSS Modules / Rails hot reloading](https://github.com/shakacode/react-webpack-rails-tutorial/pull/175). Note, while there are probably fixes after this PR was accepted, this has the majority of the changes. See [the tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/#news) for more information. Ping us if you want to help!
 
 # React on Rails
+
+**Project Objective**: To provide an opinionated and optimal framework for integrating **Ruby on Rails** with modern JavaScript tooling and libraries, including [**Webpack**](http://webpack.github.io/), [**Babel**](https://babeljs.io/), [**React**](https://github.com/rackt/react-router), [**Redux**](https://github.com/rackt/redux), [**React-Router**](https://github.com/rackt/react-router). This differs significantly from typical Rails. When considering what goes into **react_on_rails**, we ask ourselves, is the functionality related to the intersection of using Rails and with modern JavaScript? If so, then the functionality belongs right here. In other cases, we're releasing separate npm packages or Ruby gems.
+
 React on Rails integrates Facebook's [React](https://github.com/facebook/react) front-end framework with Rails. React v0.14.x is supported, with server rendering. [Redux](https://github.com/rackt/redux) and [React-Router](https://github.com/rackt/react-redux) are supported as well. See the Rails on Maui [blog post](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/) that started it all!
 
 Be sure to see the [React Webpack Rails Tutorial Code](https://github.com/shakacode/react-webpack-rails-tutorial) along with the live example at [www.reactrails.com](http://www.reactrails.com).
@@ -25,22 +28,22 @@ Please see [Getting Started](#getting-started) for how to set up your Rails proj
   ```
 
 + The `component_name` parameter is a string matching the name you used to globally expose your React component. So, in the above examples, if you had a React component named "HelloWorldApp," you would register it with the following lines:
- 
+
   ```js
   import ReactOnRails from 'react-on-rails';
   import HelloWorldApp from './HelloWorldApp';
   ReactOnRails.register({ HelloWorldApp });
   ```
- 
+
   Exposing your component in this way is how React on Rails is able to reference your component from a Rails view. You can expose as many components as you like, as long as their names do not collide. See below for the details of how you expose your components via the react_on_rails webpack configuration.
-  
+
 + `@some_props` can be either a hash or JSON string. This is an optional argument assuming you do not need to pass any options (if you want to pass options, such as `prerender: true`, but you do not want to pass any properties, simply pass an empty hash `{}`). This will make the data available in your component:
 
   ```ruby
     # Rails View
     <%= react_component("HelloWorldApp", { name: "Stranger" })
   ```
-  
+
   ```javascript
     // inside your React component
     this.props.name // "Stranger"
@@ -87,9 +90,7 @@ Like the [react-rails](https://github.com/reactjs/react-rails) gem, React on Rai
 + [Redux](https://github.com/rackt/redux)
 + [Webpack dev server](https://webpack.github.io/docs/webpack-dev-server.html) with [hot module replacement](https://webpack.github.io/docs/hot-module-replacement-with-webpack.html)
 + [Webpack optimization functionality](https://github.com/webpack/docs/wiki/optimization)
-+ _*(Coming Soon)*_ [React Router](https://github.com/rackt/react-router)
-    + *([Gem *Pull Request*](https://github.com/shakacode/react_on_rails/pull/68))*
-    + *([Tutorial Pull Request](https://github.com/shakacode/react-webpack-rails-tutorial/pull/128))*
++ [React Router](https://github.com/rackt/react-router)
 
 See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
 
@@ -126,7 +127,7 @@ We're definitely not doing that. With react_on_rails, webpack is mainly generati
   rails generate react_on_rails:install
   ```
 
-3. NPM install. Make sure you are on a recent version of node, preferably using nvm.
+3. NPM install. Make sure you are on a recent version of node, preferably using nvm. We've heard some reports that you need at least Node v5.
 
   ```bash
   npm install
@@ -208,7 +209,7 @@ This is how you actually render the React components you exposed to `window` ins
 #### react_component
 `react_component(component_name, props = {}, options = {})`
 
-+ **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.
++ **component_name:** Can be a React component, created using a ES6 class, or `React.createClass`, or a generator function that returns a React component.
 + **props:** Ruby Hash which contains the properties to pass to the react object, or a JSON string. If you pass a string, we'll escape it for you.
 + **options:**
   + **prerender:** enable server-side rendering of component. Set to false when debugging!
@@ -231,7 +232,7 @@ This is a helper method that takes any JavaScript expression and returns the out
 
 ## 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.
- 
+
 Run `rails generate react_on_rails:install --help` for descriptions of all available options:
 
 ```
@@ -256,10 +257,10 @@ Description:
     Create react on rails files for install generator.
 ```
 
-For a clear example of what each generator option will do, see our generator results repo: [Generator Results](https://github.com/shakacode/react_on_rails-generator-results/blob/master/README.md). Each pull request shows a git "diff" that highlights the changes that the generator has made.
+For a clear example of what each generator option will do, see our generator results repo: [Generator Results](https://github.com/shakacode/react_on_rails-generator-results/blob/master/README.md). Each pull request shows a git "diff" that highlights the changes that the generator has made. Another good option is to create a simple test app per the [Tutorial for v2.0](docs/tutorial-v2.md).
 
 ### Understanding the Organization of the Generated Client Code
-The generated client code follows our organization scheme. Each unique set of functionality, is given its own folder inside of `client/app/bundles`. This encourages for modularity of DOMAINS.
+The generated client code follows our organization scheme. Each unique set of functionality, is given its own folder inside of `client/app/bundles`. This encourages for modularity of *domains*.
 
 Inside of the generated "HelloWorld" domain you will find the following folders:
 

data/docs/tutorial-v2.md

@@ -1,3 +1,5 @@
+# Tutorial for v2.0
+
 I just released RC3 of [React On Rails](https://github.com/shakacode/react_on_rails/tree/npm-react-on-rails-js). Here's a tiny tutorial to get you started. This tutorial setups up a new Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering.
 
 You can find:
@@ -46,7 +48,7 @@ npm run rails-server
 Visit http://localhost:3000/hello_world and see your React On Rails app running!
 
 ```
-npm run node-server-hot
+npm run express-server
 ```
 
 <img src="http://forum.shakacode.com/uploads/default/original/1X/5bd396a7f9c0764929b693fb79eb6685ec6f62cf.png" width="470" height="499">

data/lib/generators/react_on_rails/base_generator.rb

@@ -192,6 +192,24 @@ module ReactOnRails
         new_name = File.join(destination_root, "#{base_path}application.scss")
         File.rename(bad_name, new_name)
       end
+
+      def print_helpful_message
+        message = <<-MSG.strip_heredoc
+
+          What to do next:
+
+            - Ensure your bundle and npm are up to date.
+
+                bundle && npm i
+
+            - Run the npm rails-server command to load the rails server.
+
+                npm run rails-server
+
+            - Visit http://localhost:3000/hello_world and see your React On Rails app running!
+        MSG
+        GeneratorMessages.add_info(message)
+      end
     end
   end
 end

data/lib/generators/react_on_rails/generator_messages.rb

@@ -16,7 +16,7 @@ module GeneratorMessages
       output << format_info(message)
     end
 
-    def errors
+    def messages
       output
     end
 

data/lib/generators/react_on_rails/install_generator.rb

@@ -62,15 +62,15 @@ module ReactOnRails
           # fail("react_on_rails generator prerequisites not met!")
         end
       ensure
-        print_errors
+        print_generator_messages
       end
 
       # Everything here is not run automatically b/c it's private
 
       private
 
-      def print_errors
-        GeneratorMessages.errors.each { |errors| puts errors }
+      def print_generator_messages
+        GeneratorMessages.messages.each { |message| puts message }
       end
 
       def invoke_generators # rubocop:disable Metrics/CyclomaticComplexity

data/lib/generators/react_on_rails/react_with_redux_generator.rb

@@ -45,6 +45,17 @@ module ReactOnRails
         location = "client/app/bundles/HelloWorld/startup"
         template("redux/base/#{location}/HelloWorldAppClient.jsx.tt", "#{location}/#{filename}")
       end
+
+      def print_helpful_message
+        message = <<-MSG
+  - Run the npm express-server command to load the node server with hot reloading support.
+
+      npm run express-server
+
+  - Visit http://localhost:4000 and see your React On Rails app running using the Webpack Dev server.
+        MSG
+        GeneratorMessages.add_info(message)
+      end
     end
   end
 end

data/lib/generators/react_on_rails/templates/base/base/client/package.json.tt

@@ -1,4 +1,4 @@
-<%- require 'react_on_rails/version' -%>
+<%- require "react_on_rails/version_syntax_converter" -%>
 {
   "name": "react-webpack-rails-tutorial",
   "version": "1.1.0",
@@ -64,7 +64,7 @@
     "react-bootstrap": "^0.28.1",
     <%- end -%>
     "react-dom": "^0.14.3",
-    "react-on-rails": "<%= x = ReactOnRails::VERSION.match(/(\d+\.\d+\.\d+)/); "#{x[1]}" %>",
+    "react-on-rails": "<%= VersionSyntaxConverter.new.rubygem_to_npm %>",
     <%- if options.redux? -%>
     "react-redux": "^4.0.5",
     "redux": "^3.0.5",

data/lib/generators/react_on_rails/templates/base/base/package.json

@@ -10,7 +10,7 @@
   "scripts": {
     "postinstall": "cd client && npm install",
     "test": "rspec && (cd client && npm run lint)",
-    "node-server-hot": "echo 'visit http://localhost:4000' && cd client && npm start",
+    "express-server": "echo 'visit http://localhost:4000' && cd client && npm start",
     "rails-server": "echo 'visit http://localhost:3000/hello_world' && foreman start -f Procfile.dev"
   },
   "repository": {

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/lib/react_on_rails/version_checker.rb

@@ -1,6 +1,9 @@
 require_relative "version"
+require_relative "version_syntax_converter"
 
 module ReactOnRails
+  # Responsible for checking versions of rubygem versus npm node package
+  # against each otherat runtime.
   class VersionChecker
     attr_reader :node_package_version, :logger
 
@@ -13,10 +16,12 @@ module ReactOnRails
       @node_package_version = node_package_version
     end
 
-    # For compatibility, the gem and the node package versions should always match, unless the user
-    # really knows what they're doing. So we will give a warning if they do not.
+    # For compatibility, the gem and the node package versions should always match,
+    # unless the user really knows what they're doing. So we will give a
+    # warning if they do not.
     def warn_if_gem_and_node_package_versions_differ
-      return if node_package_version.major == gem_major_version || node_package_version.relative_path?
+      return if node_package_version.relative_path?
+      return if node_package_version.major == gem_major_version
       log_differing_versions_warning
     end
 
@@ -58,21 +63,13 @@ module ReactOnRails
         JSON.parse(package_json_contents)["dependencies"]["react-on-rails"]
       end
 
-      def normalized
-        match = raw
-                .tr("-", ".")
-                .strip
-                .match(/(\d.*)/)
-        match.present? ? match[0] : nil
-      end
-
       def relative_path?
-        normalized.nil? # must be a relative path if nil and we haven't failed
+        raw.match(/\.\./).present?
       end
 
       def major
-        return if normalized.nil?
-        normalized.match(/(\d+)\./)[1]
+        return if relative_path?
+        raw.match(/(\d+)\./)[1]
       end
 
       private

data/lib/react_on_rails/version_syntax_converter.rb

@@ -0,0 +1,20 @@
+require_relative "version"
+
+class VersionSyntaxConverter
+  def rubygem_to_npm(rubygem_version = ReactOnRails::VERSION)
+    regex_match = rubygem_version.match(/(\d+\.\d+\.\d+)[.\-]?(.+)?/)
+    if regex_match[2]
+      return "#{regex_match[1]}-#{regex_match[2]}"
+    else
+      return "#{regex_match[1]}"
+    end
+  end
+
+  def npm_to_rubygem(npm_version)
+    match = npm_version
+            .tr("-", ".")
+            .strip
+            .match(/(\d.*)/)
+    match.present? ? match[0] : nil
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "2.0.0",
+  "version": "2.0.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: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -378,6 +378,7 @@ files:
 - lib/react_on_rails/server_rendering_pool.rb
 - lib/react_on_rails/version.rb
 - lib/react_on_rails/version_checker.rb
+- lib/react_on_rails/version_syntax_converter.rb
 - package.json
 - rakelib/docker.rake
 - rakelib/dummy_apps.rake