react_on_rails 2.0.0.beta.2 → 2.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e31774c6bd02e65296e93fbfbefbf45ffcbe2a9b
-  data.tar.gz: 7734b39bc33436dbbb9fbe611be63e32320cfbd5
+  metadata.gz: 1e6a3e3f5a956072da985398fcc4a47717c1c654
+  data.tar.gz: 54dd160efba8dfe5ce0c35c2d56fb326f5e82984
 SHA512:
-  metadata.gz: 5e36562a5e9bb7aca5cdbba893d94e1fcea207a31dbd67e2fa2d0a3af8ef23c8a40820839d15b6a3edfb4b11f2e869b083752f62fdd81638cee865d828eb9f74
-  data.tar.gz: b19b18901a1c8e08a880b72a88acebb5dfcaf46b8300133228457565da75c1fc8590012f734e06d021400d42d1841daf05458edc33c2977e1ae9a1ea7a12cd39
+  metadata.gz: 7f6910bd7f55013c68d046febb69b0b709cb470351b2ce008a66580336cd9a540e1f7cf97f7480bb0a617c681e4004b284785db8e1d4d7eb75dab1a417a811cb
+  data.tar.gz: cfbb296cbd1b90af417facd4850292eb9f76a705eadd380535dd9d50b2fdba1000212d7c46b2d248dc325bd7f6b0eab519543afecb6d436093adf616589973dc

data/.rubocop.yml

@@ -8,11 +8,13 @@ AllCops:
   Exclude:
     - 'vendor/**/*'
     - 'spec/fixtures/**/*'
+    - 'node_modules/**/*.*'
     - 'node_modules/**/*'
     - 'coverage/**/*'
     - 'db/**/*'
     - 'db/schema.rb'
     - 'db/seeds.rb'
+    - 'client/node_modules/**/*.*'
     - 'client/node_modules/**/*'
     - 'bin/**/*'
     - !ruby/regexp /old_and_unused\.rb$/

data/.travis.yml

@@ -25,6 +25,7 @@ before_install:
 install:
   - rm -rf ~/.nvm && git clone https://github.com/creationix/nvm.git ~/.nvm && (cd ~/.nvm && git checkout `git describe --abbrev=0 --tags`) && source ~/.nvm/nvm.sh && nvm install 4.2.0
   - npm install -g npm
+  - npm install -g poltergeist
   - bundle install
   - npm install
   - rake dummy_apps
@@ -34,6 +35,7 @@ install:
 before_script:
   - "export DISPLAY=:99"
   - Xvfb :99 -ac -screen scn 1600x1200x16 &
+  - npm run symlink_node_package
 
 script:
   - rake

data/Gemfile

@@ -16,6 +16,7 @@ gem "coffee-rails", "~> 4.1.0"
 gem "jbuilder", "~> 2.0"
 gem "jquery-rails"
 gem "launchy"
+gem "poltergeist"
 gem "pry"
 gem "pry-byebug"
 gem "pry-doc"

data/Rakefile

@@ -3,3 +3,8 @@
 
 desc "Run all tests and linting"
 task default: ["run_rspec", "docker:lint"]
+
+desc "Has all examples and dummy apps use local node_package folder for react-on-rails node dependency"
+task :symlink_node_package do
+  sh_in_dir(gem_root, "npm run symlink_node_package")
+end

data/app/helpers/react_on_rails_helper.rb

@@ -146,7 +146,6 @@ module ReactOnRailsHelper
 
   # Returns Array [0]: html, [1]: script to console log
   # NOTE, these are NOT html_safe!
-  # rubocop:disable Metrics/CyclomaticComplexity
   def server_rendered_react_component_html(options, props, react_component_name, dom_id)
     return { "html" => "", "consoleReplayScript" => "" } unless prerender(options)
 

data/docs/contributing.md

@@ -1,6 +1,13 @@
 # Tips for Contributors
 *See [Releasing](../releasing.md) for instructions on releasing.*
 
+* After Syncing, to prepare all examples and run all tests
+
+```
+bundle && npm i && rake examples:prepare_all && rake symlink_node_package && rake
+```
+
+
 # IDE/IDE SETUP
 It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl!
 
@@ -28,8 +35,10 @@ Note that you will need to bundle install after making this change, but also tha
 ## NPM for react-on-rails
 First, be **sure** to build the NPM package
 
-    npm i
-    npm run build
+```sh
+npm i
+npm run build
+```
 
 Use either npm-link (described below), or use a relative path in your `package.json`, like this:
 
@@ -39,7 +48,6 @@ Use either npm-link (described below), or use a relative path in your `package.j
 
 If you use a relative path, be sure to run `npm i` whenever you rebuild the node package.
 
-
 # Development Setup for Gem and Node Package Contributors
 
 ## Checklist before Committing
@@ -52,18 +60,22 @@ If you use a relative path, be sure to run `npm i` whenever you rebuild the node
 ### Prereqs
 After checking out the repo, making sure you have rvm and nvm setup (setup ruby and node), cd to `spec/dummy` and run `bin/setup` to install ruby dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-### Npm link
+Additionally, our RSpec tests use the poltergeist web driver. You will need to install the poltergeist node module:
+
+```sh
+npm install -g poltergeist
+```
 
-By the following steps, the node package code of react-on-rails is directly coming from `node_package/lib`
+### NPM link
+Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the app's root directory and run:
 
 ```sh
-cd <top level>
-npm link
-cd spec/dummy/client
-npm link react-on-rails
+npm run symlink_node_package
 ```
 
-*Side note: It's critical to use the alias section of the webpack config to avoid the double inclusion error:*
+From now on, the example and dummy apps will use your local node_package folder as the react-on-rails node package. This will also be done automatically for you via the `rake examples:prepare_all` rake task.
+
+*Side note: It's critical to use the alias section of the webpack config to avoid a double inclusion error. This has already been done for you in the example and dummy apps, but for reference:*
 
 ```js
   resolve: {
@@ -73,7 +85,7 @@ npm link react-on-rails
   },
 ```
 
-### Install npm dependencies and build the npm package for react-on-rails 
+### Install NPM dependencies and build the NPM package for react-on-rails
 
 ```sh
 cd <top level>
@@ -83,7 +95,7 @@ cd spec/dummy
 npm i
 ```
 
-### Run npm JS tests
+### Run NPM JS tests
 
 ```sh
 cd <top level>
@@ -96,15 +108,14 @@ npm test
 cd spec/dummy
 npm run test
 ```
- 
+
 ### Run most tests and linting
 
-```
+```sh
 cd <top level>
 node_package/scripts/ci
 ```
 
-
 ### Starting the Dummy App
 To run the test app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start`. If you don't do this, then `webpack` will not generate a new bundle, and you will be seriously confused when you change JavaScript and the app does not change. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `node_package/scripts/build`. Since the react-on-rails package should be sym linked, you don't have to `npm i react-on-rails` after every change.
 
@@ -118,14 +129,14 @@ After running a test, you can view the coverage results SimpleCov reports by ope
 ### Debugging
 Start the sample app like this for some debug printing:
 
-```bash
+```sh
 TRACE_REACT_ON_RAILS=true && foreman start
 ```
 
 ### Install Generator
 In your Rails app add this gem with a path to your fork.
 
-```
+```ruby
 gem 'react_on_rails', path: '../relative/path/to/react_on_rails'
 ```
 
@@ -147,11 +158,11 @@ Run `rake -D docker` to see all docker linting commands for rake. `rake docker:l
 
 You can run specific linting for directories or files by using `docker-compose run lint rubocop (file path or directory)`, etc.
 
-`docker-compose run lint bash` sets you up to run from the container command line. 
+`docker-compose run lint bash` sets you up to run from the container command line.
 
 ### Docker CI - Test and Linting
 Docker CI and Tests containers have a xvfd server automatically started for headless browser testing with selenium and Firefox.
 
 Run `docker-compose build ci` to build the CI container. Run `docker-compose run ci` to start all rspec tests and linting. `docker-compose run --entrypoint=/bin/bash` will override the default CI action and place you inside the CI container in a bash session. This is what is run on Travis-CI.
 
-Run `docker-compose build tests` to build the tests container. Run `docker-compose run tests` to start all rspec tests.
+Run `docker-compose build tests` to build the tests container. Run `docker-compose run tests` to start all RSpec tests.

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -33,6 +33,7 @@ module ReactOnRails
         gem("capybara", group: :test)
         gem("selenium-webdriver", group: :test)
         gem("coveralls", require: false)
+        gem("poltergeist")
       end
     end
   end

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

@@ -27,6 +27,8 @@ module.exports = {
     extensions: ['', '.webpack.js', '.web.js', '.js', '.jsx', '.scss', '.css', 'config.js'],
     alias: {
       lib: path.join(process.cwd(), 'app', 'lib'),
+      react: path.resolve('./node_modules/react'),
+      'react-dom': path.resolve('./node_modules/react-dom'),
     },
   },
   plugins: [

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

@@ -11,6 +11,8 @@ require_relative "spec_helper"
 require "rspec/rails"
 require "capybara/rspec"
 require "capybara/rails"
+require "capybara/poltergeist"
+Capybara.javascript_driver = :poltergeist
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are

data/lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/actions/helloWorldActionCreators.jsx

@@ -1,4 +1,4 @@
-import * as actionTypes from '../constants/helloWorldConstants';
+import actionTypes from '../constants/helloWorldConstants';
 
 export function updateName(name) {
   return {

data/lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx

@@ -11,9 +11,11 @@ export default class HelloWorldWidget extends React.Component {
     // We prefix all property and variable names pointing to Immutable.js objects with '$$'.
     // This allows us to immediately know we don't call $$helloWorldStore['someProperty'], but instead use
     // the Immutable.js `get` API for Immutable.Map
-    actions: PropTypes.object.isRequired,
+    actions: PropTypes.shape({
+      updateName: PropTypes.func.isRequired,
+    }).isRequired,
     $$helloWorldStore: PropTypes.instanceOf(Immutable.Map).isRequired,
-  }
+  };
 
   constructor(props, context) {
     super(props, context);

data/lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/constants/helloWorldConstants.jsx

@@ -1,8 +1,13 @@
 // See https://www.npmjs.com/package/mirror-creator
-// Allows us to easily setup constants inside of
+// Allows us to set up constants in a slightly more concise syntax. See:
 // client/app/bundles/HelloWorld/actions/helloWorldActionCreators.jsx
 import mirrorCreator from 'mirror-creator';
 
-export default mirrorCreator([
+const actionTypes = mirrorCreator([
   'HELLO_WORLD_NAME_UPDATE',
 ]);
+
+// actionTypes = {HELLO_WORLD_NAME_UPDATE: "HELLO_WORLD_NAME_UPDATE"}
+// Notice how we don't have to duplicate HELLO_WORLD_NAME_UPDATE twice
+// thanks to mirror-creator.
+export default actionTypes;

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

@@ -18,7 +18,7 @@ class HelloWorld extends React.Component {
 
     // This corresponds to the value used in function select above.
     $$helloWorldStore: PropTypes.instanceOf(Immutable.Map).isRequired,
-  }
+  };
 
   constructor(props, context) {
     super(props, context);
@@ -32,7 +32,7 @@ class HelloWorld extends React.Component {
     // This is equivalent to:
     // <HelloWorldWidget $$helloWorldStore={$$helloWorldStore} actions={actions} />
     return (
-      <HelloWorldWidget {...{$$helloWorldStore, actions}} />
+      <HelloWorldWidget {...{ $$helloWorldStore, actions }} />
     );
   }
 }

data/lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/reducers/helloWorldReducer.jsx

@@ -1,6 +1,6 @@
 import Immutable from 'immutable';
 
-import * as actionTypes from '../constants/helloWorldConstants';
+import actionTypes from '../constants/helloWorldConstants';
 
 export const $$initialState = Immutable.fromJS({
   name: '', // this is the default state that would be used if one were not passed into the store
@@ -10,10 +10,10 @@ export default function helloWorldReducer($$state = $$initialState, action) {
   const { type, name } = action;
 
   switch (type) {
-  case actionTypes.HELLO_WORLD_NAME_UPDATE:
-    return $$state.set('name', name);
+    case actionTypes.HELLO_WORLD_NAME_UPDATE:
+      return $$state.set('name', name);
 
-  default:
-    return $$state;
+    default:
+      return $$state;
   }
 }

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

@@ -16,4 +16,3 @@ export default (props) => {
   );
   return reactComponent;
 };
-

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

@@ -20,7 +20,7 @@ export default props => {
   // Redux expects to initialize the store using an Object, not an Immutable.Map
   const initialState = {
     $$helloWorldStore: $$helloWorldState.merge({
-      name: name,
+      name,
     }),
   };
 

data/lib/react_on_rails/configuration.rb

@@ -1,17 +1,12 @@
+require_relative "version_checker"
+
 module ReactOnRails
   def self.configure
     yield(configuration)
   end
 
-  # TODO ROB
-  # parse the client/package.json and ensure that either:
-  # 1. version number matches
-  # 2. version number is a relative path (for testing)
-  # Throw error if not.
-  # Allow skipping this check in the configuration in case somebody has a wacky configuration, such
-  # as you don't know where their package.json
-
   def self.configuration
+    VersionChecker.warn_if_gem_and_node_package_versions_differ
     @configuration ||= Configuration.new(
       server_bundle_js_file: "app/assets/javascripts/generated/server.js",
       prerender: false,
@@ -22,7 +17,6 @@ module ReactOnRails
       development_mode: Rails.env.development?,
       server_renderer_pool_size: 1,
       server_renderer_timeout: 20)
-    # TODO ROB: do the version check
   end
 
   class Configuration

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "2.0.0.beta.2"
+  VERSION = "2.0.0.beta.3"
 end

data/lib/react_on_rails/version_checker.rb

@@ -0,0 +1,52 @@
+require_relative "version"
+
+module ReactOnRails
+  module VersionChecker
+    # TODO: ROB
+    # parse the client/package.json and ensure that either:
+    # 1. version number matches
+    # 2. version number is a relative path (for testing)
+    # Throw error if not.
+    # Allow skipping this check in the configuration in case somebody has a wacky configuration, such
+    # as you don't know where their package.json
+
+    # 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 self.warn_if_gem_and_node_package_versions_differ
+      return unless
+        File.exist?(client_package_json) &&
+        node_package_version_is_standard_version_number? &&
+        gem_version != node_package_version
+      msg = "**WARNING** ReactOnRails: ReactOnRails gem and node package versions do not match\n" \
+            "                     gem: #{gem_version}\n" \
+            "            node package: #{node_package_version}\n" \
+            "Ensure the installed version of the gem is the same as the version of your installed node package"
+      puts(msg)
+      Rails.logger.warn(msg)
+    end
+
+    private
+
+    def self.gem_version
+      ReactOnRails::VERSION
+    end
+
+    # Warning: we replace all hyphens with periods for normalization purposes
+    def self.node_package_version
+      package_json = client_package_json
+      contents = File.read(package_json)
+      raw_version = contents.match(/"react-on-rails": "(.*)",/)[1]
+      raw_version.tr("-", ".")
+    end
+
+    def self.client_package_json
+      package_json = Rails.root.join("client", "package.json")
+    end
+
+    # Basically this means "not a relative path" as we don't want warn the user
+    # if they are purposely doing some wacky configuration.
+    def self.node_package_version_is_standard_version_number?
+      node_package_version =~ (/\d+\.\d+\.\d+(\..+\.\d+)?/)
+    end
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -42,6 +42,7 @@
   "scripts": {
     "test": "node_package/scripts/test",
     "clean": "node_package/scripts/clean",
+    "symlink-node-package": "node_package/scripts/symlink-node-package",
     "prepublish": "npm run build",
     "build": "node_package/scripts/build",
     "lint": "node_package/scripts/lint && cd spec/dummy/client && npm run lint",

data/rakelib/examples.rake

@@ -71,7 +71,9 @@ namespace :examples do
 
     # PREPARE
     desc "Prepares #{example_type.name_pretty} (generates example, `npm install`s, and generates webpack bundles)"
-    multitask example_type.prepare_task_name_short => example_type.prepared_files
+    multitask example_type.prepare_task_name_short => example_type.prepared_files do
+      Rake::Task[:refresh_node_package].invoke
+    end
   end
 
   desc "Cleans all example apps"

data/rakelib/examples_config.yml

@@ -7,7 +7,7 @@ example_type_data:
     generator_options: --server-rendering
   -
     name: redux
-    generator_options: --redux --server-rendering
+    generator_options: --redux
   -
     name: redux-server-rendering
     generator_options: --redux --server-rendering
@@ -16,4 +16,4 @@ example_type_data:
     generator_options: --heroku-deployment
   -
     name: skip-bootstrap
-    generator_options: --skip-bootstrap
+    generator_options: --skip-bootstrap

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.2
+  version: 2.0.0.beta.3
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-31 00:00:00.000000000 Z
+date: 2016-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -234,6 +234,7 @@ files:
 - lib/react_on_rails/prerender_error.rb
 - lib/react_on_rails/server_rendering_pool.rb
 - lib/react_on_rails/version.rb
+- lib/react_on_rails/version_checker.rb
 - package.json
 - rakelib/docker.rake
 - rakelib/dummy_apps.rake