react_on_rails 2.0.2 → 2.1.0

data/docs/recommended-project-structure.md

@@ -0,0 +1,22 @@
+# Project structure
+
+While React On Rails does not *enforce* a specific project structure, we do *recommend* a standard organization. The more we follow standards as a community, the easier it will be for all of us to move between various Rails projects that include React On Rails.
+
+1. `/client`: All client side JavaScript goes under the `/client` directory. Place all the major domains of the client side app under client.
+1. `/client/app`: All application JavaScript. Note the adherence to the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript#naming-conventions) where we name the files to correspond to exported Objects (PascalCase) or exported functions (camelCase). We don't use dashes or snake_case for JavaScript files, except for possibly some config files.
+1. `/client/app/bundles`: Top level of different app domains. Use a name within this directory for you app domains. For example, if you had a domain called `widget-editing`, then you would have: `/client/app/bundles/widget-editing`
+1. `/client/app/lib`: Common code for bundles
+1. Within each bundle directory (or the lib directory), such as a domain named "comments"
+`/client/app/bundle/comments`, use following directory structure:
+
+  * `/actions`: Redux actions.
+  * `/components`: "dumb" components (no connections to Redux or Ajax). These get props and can render themselves and children.
+  * `/constants`: Constants used by Redux actions and reducers.
+  * `/containers`: "smart" components. These components are bound to Redux.
+  * `/reducers`: Reducers for redux.
+  * `/routes`: Routes for React Router.
+  * `/store`: Store, which might be [configured differently for dev vs. production](https://github.com/rackt/redux/tree/master/examples/real-world/store).
+  * `/startup`: Component bindings to stores, with registration of components and stores.
+  * `/schemas`: Schemas for AJAX JSON requests and responses, as used by the [Normalizr](https://github.com/gaearon/normalizr) package.
+1. `/client/app/assets`: Assets for CSS for client app.
+1. `/client/app/assets/fonts` and `/client/app/assets/styles`: Globally shared assets for styling. Note, most Sass and image assets will be stored next to the JavaScript files.

data/docs/releasing.md

@@ -6,39 +6,71 @@ We're now releasing this as a combined ruby gem plus npm package. We will keep t
 See [Contributing](../contributing.md)
 
 ## Releasing a new gem version
-Install https://github.com/svenfuchs/gem-release
-
-```bash
-# Having the examples prevents publishing
-rm -rf examples
-gem bump
-# Or manually update the version number
-cd spec/dummy
-# Update the Gemfile.lock of the tests
-bundle
-git commit -am "Updated Gemfile.lock"
-cd ../..
-gem tag
-gem release
+Run `rake -D release` to see instructions on how to release via the rake task.
+
+
+As of 01-26-2016, this would give you an output like this:
+
 ```
+rake release[gem_version,dry_run,tools_install]
+    Releases both the gem and node package using the given version.
 
+    IMPORTANT: the gem version must be in valid rubygem format (no dashes).
+    It will be automatically converted to a valid npm semver by the rake task
+    for the node package version. This only makes a difference for pre-release
+    versions such as `3.0.0.beta.1` (npm version would be `3.0.0-beta.1`).
 
-## Releasing a npm version
-Be sure to keep the version number the same as the ruby gem!
+    This task will also globally install gem-release (ruby gem) and
+    release-it (node package) unless you specify skip installing tools.
 
-Use the npm package `release-it`
+    2nd argument: Perform a dry run by passing 'true' as a second argument.
+    3rd argument: Skip installing tools by passing 'false' as a third argument (default is true).
 
-### Commands Used for Pushing Beta
+    Example: `rake release[2.1.0,false,false]`
+```
 
-Note the npm beta version has a dash and the gem version has a dot.
+Running `rake release[2.1.0]` will create a commit that looks like this:
 
 ```
-gem bump -v 2.0.0.beta.3
-gem tag
-cd spec/dummy && bundle
-ga Gemfile.lock
-gc -m "Update Gemfile.lock for spec/dummy"
-...
-gem release
-release-it 2.0.0-beta.3
+commit d07005cde9784c69e41d73fb9a0ebe8922e556b3
+Author: Rob Wise <robert.wise@outlook.com>
+Date:   Tue Jan 26 19:49:14 2016 -0500
+
+    Release 2.1.0
+
+diff --git a/lib/react_on_rails/version.rb b/lib/react_on_rails/version.rb
+index 3de9606..b71aa7a 100644
+--- a/lib/react_on_rails/version.rb
++++ b/lib/react_on_rails/version.rb
+@@ -1,3 +1,3 @@
+ module ReactOnRails
+-  VERSION = "2.0.2".freeze
++  VERSION = "2.1.0".freeze
+ end
+diff --git a/package.json b/package.json
+index aa7b000..af8761e 100644
+--- a/package.json
++++ b/package.json
+@@ -1,6 +1,6 @@
+ {
+   "name": "react-on-rails",
+-  "version": "2.0.2",
++  "version": "2.1.0",
+   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
+   "main": "node_package/lib/ReactOnRails.js",
+   "directories": {
+diff --git a/spec/dummy/Gemfile.lock b/spec/dummy/Gemfile.lock
+index 8ef51df..4489bfe 100644
+--- a/spec/dummy/Gemfile.lock
++++ b/spec/dummy/Gemfile.lock
+@@ -1,7 +1,7 @@
+ PATH
+   remote: ../..
+   specs:
+-    react_on_rails (2.0.2)
++    react_on_rails (2.1.0)
+       connection_pool
+       execjs (~> 2.5)
+       rails (>= 3.2)
+(END)
 ```

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -24,7 +24,7 @@ module ReactOnRails
         package_json = File.join(destination_root, "client", "package.json")
         old_contents = File.read(package_json)
         new_contents = old_contents.gsub(/"react-on-rails": ".+",/,
-                                         '"react-on-rails": "../../..",')
+                                         '"react-on-rails": "../../../..",')
         File.open(package_json, "w+") { |f| f.puts new_contents }
       end
 

data/lib/generators/react_on_rails/generator_messages.rb

@@ -29,7 +29,7 @@ module GeneratorMessages
     end
 
     def format_info(msg)
-      Rainbow("#{msg}").green
+      Rainbow(msg.to_s).green
     end
 
     def clear

data/lib/generators/react_on_rails/install_generator.rb

@@ -59,7 +59,6 @@ module ReactOnRails
         else
           error = "react_on_rails generator prerequisites not met!"
           GeneratorMessages.add_error(error)
-          # fail("react_on_rails generator prerequisites not met!")
         end
       ensure
         print_generator_messages
@@ -87,7 +86,7 @@ module ReactOnRails
       # js(.coffee) are not checked by this method, but instead produce warning messages
       # and allow the build to continue
       def installation_prerequisites_met?
-        !(missing_node? || missing_npm? || uncommitted_changes?)
+        !(missing_node? || missing_npm? || ReactOnRails::GitUtils.uncommitted_changes?(GeneratorMessages))
       end
 
       def missing_npm?
@@ -105,15 +104,6 @@ module ReactOnRails
         GeneratorMessages.add_error(error)
         true
       end
-
-      def uncommitted_changes?
-        return false if ENV["COVERAGE"]
-        status = `git status`
-        return false if status.include?("nothing to commit, working directory clean")
-        error = "You have uncommitted code. Please commit or stash your changes before continuing"
-        GeneratorMessages.add_error(error)
-        true
-      end
     end
   end
 end

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

@@ -38,40 +38,41 @@
   },
   "dependencies": {
     "babel": "^6.3.26",
-    "babel-cli": "^6.3.17",
-    "babel-core": "^6.3.26",
-    "babel-loader": "^6.2.0",
+    "babel-cli": "^6.4.5",
+    "babel-core": "^6.4.5",
+    "babel-loader": "^6.2.1",
     "babel-plugin-syntax-decorators": "^6.3.13",
     "babel-polyfill": "^6.3.14",
     "babel-preset-es2015": "^6.3.13",
     "babel-preset-react": "^6.3.13",
     "babel-preset-stage-0": "^6.3.13",
-    "es5-shim": "^4.4.1",
+    "babel-types": "^6.4.5",
+    "es5-shim": "^4.5.0",
     "expose-loader": "^0.7.1",
     <%- if options.redux? -%>
-    "immutable": "^3.7.5",
+    "immutable": "^3.7.6",
     <%- end -%>
     "imports-loader": "^0.6.5",
-    "jquery": "^2.1.4",
+    "jquery": "^2.2.0",
     "jquery-ujs": "^1.1.0-1",
-    "loader-utils": "^0.2.11",
-    "lodash": "^3.10.1",
+    "loader-utils": "^0.2.12",
+    "lodash": "^4.0.0",
     <%- if options.redux? -%>
-    "mirror-creator": "0.0.1",
+    "mirror-creator": "1.0.0",
     <%- end -%>
-    "react": "^0.14.3",
+    "react": "^0.14.6",
     <%- unless options.skip_bootstrap? -%>
-    "react-bootstrap": "^0.28.1",
+    "react-bootstrap": "^0.28.2",
     <%- end -%>
-    "react-dom": "^0.14.3",
+    "react-dom": "^0.14.6",
     "react-on-rails": "<%= VersionSyntaxConverter.new.rubygem_to_npm %>",
     <%- if options.redux? -%>
-    "react-redux": "^4.0.5",
-    "redux": "^3.0.5",
-    "redux-promise": "^0.5.0",
-    "redux-thunk": "^1.0.2",
+    "react-redux": "^4.0.6",
+    "redux": "^3.0.6",
+    "redux-promise": "^0.5.1",
+    "redux-thunk": "^1.0.3",
     <%- end -%>
-    "webpack": "^1.12.8"
+    "webpack": "^1.12.12"
   },
   "devDependencies": {
     <%- unless options.skip_js_linters? -%>
@@ -79,27 +80,27 @@
     <%- end -%>
     "babel-plugin-react-transform": "^2.0.0",
     <%- unless options.skip_bootstrap? -%>
-    "bootstrap-sass": "^3.3.5",
-    "bootstrap-sass-loader": "^1.0.9",
+    "bootstrap-sass": "^3.3.6",
+    "bootstrap-sass-loader": "^1.0.10",
     <%- end -%>
-    "css-loader": "^0.23.0",
+    "css-loader": "^0.23.1",
     <%- unless options.skip_js_linters? -%>
     "eslint": "^1.10.3",
-    "eslint-config-airbnb": "^2.0.0",
-    "eslint-config-shakacode": "^0.0.1",
-    "eslint-plugin-react": "^3.11.3",
+    "eslint-config-airbnb": "^4.0.0",
+    "eslint-config-shakacode": "^1.0.0",
+    "eslint-plugin-react": "^3.16.1",
     <%- end -%>
-    "express": "^4.13.3",
-    "file-loader": "^0.8.4",
+    "express": "^4.13.4",
+    "file-loader": "^0.8.5",
     "jade": "^1.11.0",
     <%- unless options.skip_js_linters? -%>
     "jscs": "^2.8.0",
     <%- end -%>
     "node-sass": "^3.4.2",
     "react-transform-hmr": "^1.0.1",
-    "sass-loader": "^3.1.1",
+    "sass-loader": "^3.1.2",
     "style-loader": "^0.13.0",
-    "url-loader": "^0.5.6",
-    "webpack-dev-server": "^1.12.1"
+    "url-loader": "^0.5.7",
+    "webpack-dev-server": "^1.14.1"
   }
 }

data/lib/generators/react_on_rails/templates/base/base/client/server.js

@@ -6,7 +6,10 @@ var WebpackDevServer = require('webpack-dev-server');
 var jade = require('jade');
 var config = require('./webpack.client.hot.config');
 
-var server = new WebpackDevServer(webpack(config), {
+const PORT = 4000;
+const compiler = webpack(config);
+
+var server = new WebpackDevServer(compiler, {
   publicPath: config.output.publicPath,
   hot: true,
   historyApiFallback: true,
@@ -49,16 +52,21 @@ var server = new WebpackDevServer(webpack(config), {
 
 var initialName = 'Stranger';
 
-server.app.use('/', function routePath(req, res) {
+server.app.use('/', (req, res) => {
   var locals = {
     props: JSON.stringify(initialName),
   };
-  var layout = process.cwd() + '/index.jade';
+  var layout = `${process.cwd()}/index.jade`;
   var html = jade.compileFile(layout, { pretty: true })(locals);
   res.send(html);
 });
 
-server.listen(4000, 'localhost', function onListen(err) {
-  if (err) console.log(err);
-  console.log('Listening at localhost:4000...');
+server.listen(PORT, 'localhost', err => {
+  if (err) console.error(err);
+  console.log(
+    '=> 🔥  Webpack development server is running on port ' + PORT
+  );
+});
+compiler.plugin('done', () => {
+  process.stdout.write('Webpack: Done compiling assets!\n');
 });

data/lib/generators/react_on_rails/templates/base/base/client/webpack.client.base.config.js

@@ -18,7 +18,8 @@ module.exports = {
       'jquery',
     ],
 
-    // This will contain the app entry points defined by webpack.hot.config and webpack.rails.config
+    // This will contain the app entry points defined by webpack.hot.config and
+    // webpack.rails.config
     app: [
       './app/bundles/HelloWorld/startup/clientRegistration',
     ],
@@ -55,7 +56,8 @@ module.exports = {
   module: {
     loaders: [
 
-      // Not all apps require jQuery. Many Rails apps do, such as those using TurboLinks or bootstrap js
+      // Not all apps require jQuery. Many Rails apps do, such as those using TurboLinks or
+      // bootstrap js
       { test: require.resolve('jquery'), loader: 'expose?jQuery' },
       { test: require.resolve('jquery'), loader: 'expose?$' },
     ],

data/lib/generators/react_on_rails/templates/base/base/client/webpack.client.hot.config.js.tt

@@ -54,8 +54,8 @@ config.module.loaders.push(
   { test: /\.css$/, loader: 'style-loader!css-loader' },
   {
     test: /\.scss$/,
-    loader: 'style!css!sass?outputStyle=expanded&imagePath=/assets/images&includePaths[]=' +
-    path.resolve(__dirname, './assets/stylesheets'),
+    loader: `style!css!sass?outputStyle=expanded&imagePath=/assets/images&includePaths[]=\
+${path.resolve(__dirname, './assets/stylesheets')}`,
   },
 
   // The url-loader uses DataUrls. The file-loader emits files.

data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb

@@ -23,4 +23,6 @@ ReactOnRails.configure do |config|
   config.prerender = false
   # Default is true for development, off otherwise
   config.trace = Rails.env.development?
+  # Default is false, enable if your content security policy doesn't include `style-src: 'unsafe-inline'`
+  config.skip_display_none = false
 end

data/lib/generators/react_on_rails/templates/dev_tests/spec/simplecov_helper.rb

@@ -10,7 +10,7 @@ if ENV["COVERAGE"]
   SimpleCov.start("rails") do
     # Consider the entire gem project as the root
     # (typically this will be the folder named "react_on_rails")
-    gem_root_path = File.expand_path("../../../../.", __FILE__)
+    gem_root_path = File.expand_path("../../../../../.", __FILE__)
     root gem_root_path
 
     # Don't report anything that has "spec" in the path

data/lib/generators/react_on_rails/templates/no_redux/base/client/app/bundles/HelloWorld/startup/HelloWorldAppClient.jsx.tt

@@ -1,8 +1,6 @@
 import React from 'react';
 import HelloWorld from '../containers/HelloWorld';
 
-export default (props) => {
-  return (
-    <HelloWorld {...props} />
-  );
-};
+export default (props) => (
+  <HelloWorld {...props} />
+);

data/lib/generators/react_on_rails/templates/no_redux/server_rendering/client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx

@@ -1,8 +1,6 @@
 import React from 'react';
 import HelloWorld from '../containers/HelloWorld';
 
-export default (props) => {
-  return (
-    <HelloWorld {...props} />
-  );
-};
+export default (props) => (
+  <HelloWorld {...props} />
+);

data/lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/store/helloWorldStore.jsx

@@ -1,8 +1,9 @@
 import { compose, createStore, applyMiddleware, combineReducers } from 'redux';
 
-// See https://github.com/gaearon/redux-thunk and http://redux.js.org/docs/advanced/AsyncActions.html
-// This is not actually used for this simple example, but you'd probably want to use this once your app has
-// asynchronous actions.
+// See
+// https://github.com/gaearon/redux-thunk and http://redux.js.org/docs/advanced/AsyncActions.html
+// This is not actually used for this simple example, but you'd probably want to use this
+// once your app has asynchronous actions.
 import thunkMiddleware from 'redux-thunk';
 
 // This provides an example of logging redux actions to the console.

data/lib/react_on_rails.rb

@@ -1,6 +1,17 @@
 require "rails"
 
 require "react_on_rails/version"
+require "react_on_rails/version_checker"
 require "react_on_rails/configuration"
 require "react_on_rails/server_rendering_pool"
 require "react_on_rails/engine"
+require "react_on_rails/version_syntax_converter"
+require "react_on_rails/ensure_assets_compiled"
+require "react_on_rails/git_utils"
+require "react_on_rails/utils"
+
+module ReactOnRails
+  def self.configure_rspec_to_compile_assets(config, metatag = :js)
+    config.before(:example, metatag) { ReactOnRails::EnsureAssetsCompiled.check_built_assets }
+  end
+end

data/lib/react_on_rails/configuration.rb

@@ -14,35 +14,37 @@ module ReactOnRails
       trace: Rails.env.development?,
       development_mode: Rails.env.development?,
       server_renderer_pool_size: 1,
-      server_renderer_timeout: 20)
+      server_renderer_timeout: 20,
+      skip_display_none: false)
   end
 
   class Configuration
     attr_accessor :server_bundle_js_file, :prerender, :replay_console,
                   :trace, :development_mode,
                   :logging_on_server, :server_renderer_pool_size,
-                  :server_renderer_timeout, :raise_on_prerender_error
+                  :server_renderer_timeout, :raise_on_prerender_error,
+                  :skip_display_none
 
     def initialize(server_bundle_js_file: nil, prerender: nil, replay_console: nil,
                    trace: nil, development_mode: nil,
                    logging_on_server: nil, server_renderer_pool_size: nil,
-                   server_renderer_timeout: nil, raise_on_prerender_error: nil)
-      if File.exist?(server_bundle_js_file)
-        self.server_bundle_js_file = server_bundle_js_file
-      else
-        self.server_bundle_js_file = nil
-      end
+                   server_renderer_timeout: nil, raise_on_prerender_error: nil,
+                   skip_display_none: nil)
+      self.server_bundle_js_file = if File.exist?(server_bundle_js_file)
+                                     server_bundle_js_file
+                                   end
 
       self.prerender = prerender
       self.replay_console = replay_console
       self.logging_on_server = logging_on_server
-      if development_mode.nil?
-        self.development_mode = Rails.env.development?
-      else
-        self.development_mode = development_mode
-      end
+      self.development_mode = if development_mode.nil?
+                                Rails.env.development?
+                              else
+                                development_mode
+                              end
       self.trace = trace.nil? ? Rails.env.development? : trace
       self.raise_on_prerender_error = raise_on_prerender_error
+      self.skip_display_none = skip_display_none
 
       # Server rendering:
       self.server_renderer_pool_size = self.development_mode ? 1 : server_renderer_pool_size