react_on_rails 6.6.0.alpha.1 → 6.6.0

data/docs/additional-reading/node-server-rendering.md

@@ -30,7 +30,7 @@ config.server_render_method = "NodeJS"
 
 You need to configure the name of the server bundle in two places:
 
-1. JavaScript: Change the name of server bundle adjust npm start script in `client/node/package.json`
+1. JavaScript: Change the name of server bundle and adjust yarn start script in `client/node/package.json`
 2. Ruby: The configured server bundle file is defined in `config/react_on_rails.rb`, and you'll have a webpack file that creates this. You maybe using the same file for client rendering.
 
 ```ruby

data/docs/additional-reading/rspec-configuration.md

@@ -25,12 +25,12 @@ The following `config/react_on_rails.rb` settings **must** match your setup:
   config.webpack_generated_files = %w( webpack-bundle.js )
   
   # If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
-  # with rspec then this controls what npm command is run
+  # with rspec then this controls what yarn command is run
   # to automatically refresh your webpack assets on every test run.
-  config.npm_build_test_command = "npm run build:test"
+  config.npm_build_test_command = "yarn run build:test"
 ```
 
-If you want to speed up the re-compiling process, you can call `npm run build:development` (per below script) to have webpack run in "watch" mode and recompile these files in the background, which will be much faster when making incremental changes than compiling from scratch, assuming you have your setup like this:
+If you want to speed up the re-compiling process, you can call `yarn run build:development` (per below script) to have webpack run in "watch" mode and recompile these files in the background, which will be much faster when making incremental changes than compiling from scratch, assuming you have your setup like this:
 
 ```
   "scripts": {

data/docs/additional-reading/turbolinks.md

@@ -2,7 +2,7 @@
 
 * See [Turbolinks on Github](https://github.com/rails/turbolinks)
 * Currently support 2.5.x of Turbolinks and 5.0.0 of Turbolinks 5.
-* You may include Turbolinks either via npm (recommended) or via the gem.
+* You may include Turbolinks either via yarn (recommended) or via the gem.
 
 ## Why Turbolinks?
 As you switch between Rails HTML controller requests, you will only load the HTML and you will
@@ -23,7 +23,7 @@ the JavaScript and stylesheets are cached by the browser, as they will still req
 * If you're using multiple Webpack bundles, be sure to ensure that there are no name conflicts between JS objects or redux store paths.
 
 ### Install Checklist
-1. Include turbolinks via npm as shown in the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/8a6c8aa2e3b7ae5b08b0a9744fb3a63a2fe0f002/client/webpack.client.base.config.js#L22) or include the gem "turbolinks".
+1. Include turbolinks via yarn as shown in the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/8a6c8aa2e3b7ae5b08b0a9744fb3a63a2fe0f002/client/webpack.client.base.config.js#L22) or include the gem "turbolinks".
 1. Included the proper "track" tags when you include the javascript and stylesheet:
   ```erb
     <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => 'reload' %>

data/docs/additional-reading/updating-dependencies.md

@@ -13,21 +13,19 @@ bundle update
 ## NPM
 
 1. Install [npm-check-updates](https://www.npmjs.com/package/npm-check-updates)
-1. Run `npm outdated` and read CHANGELOGs of major updated packages before you update. You might not be ready for some updates.
-1. Run these commands. Note, you may or may not want to remove your npm-shrinkwrap.json if you get some werid conflicts, and you may or may not need to `rm -rf` your `node_modules` directory. 
+1. Run `yarn outdated` and read CHANGELOGs of major updated packages before you update. You might not be ready for some updates.
+1. Run these commands. You may or may not need to `rm -rf` your `node_modules` directory. 
 
 ```
 cd client
-rm npm-shrinkwrap.json
 ncu -u -a
-npm i
+yarn
 ```
 
 Some combinations that I often run:
 
 ### remove old installed `node_modules` so you only get what corresponds to package.json
 ```
-ncu -u -a && rm -rf node_modules && npm i
+ncu -u -a && rm -rf node_modules && yarn
 ```
 
-Note: newer versions of npm (>3) automatically create a new version of the npm-shrinkwrap.json.

data/docs/contributor-info/generator-testing.md

@@ -12,7 +12,7 @@ You can specify additional apps to generate and test by adding to the rakelib/ex
 ## More on the Rake Tasks
 In order to maximize efficiency, we took several steps to improve the performance of the rake tasks that utilize somewhat advanced rake functionality such as task dependencies, `file` tasks, task synthesizing, and concurrent tasks with `multitask`.
 
-For example, re-generating the app, running `npm install`, and re-generating the webpack bundles are all only done when they need to be done. Rake will also run certain tasks, including those that generate multiple applications, concurrently. When running `npm install`, this may produce strange-looking output due to the way the npm's console progress bar works. This is normal.
+For example, re-generating the app, running `yarn`, and re-generating the webpack bundles are all only done when they need to be done. Rake will also run certain tasks, including those that generate multiple applications, concurrently. 
 
 For more insight, see:
 

data/docs/tutorial.md

@@ -19,6 +19,8 @@ By the time you read this, the latest may have changed. Be sure to check the ver
 * https://rubygems.org/gems/react_on_rails
 * https://www.npmjs.com/package/react-on-rails
 
+_Note: some of the screen images below show the "npm" command. react_on_rails 6.6.0 and greater uses `yarn`._
+
 ##Setting up the environment
 
 Trying out **React on Rails** is super easy, so long as you have the basic prerequisites. This includes the basics for Rails 4.x and node version 5+. I recommend `rvm` and `nvm` to install Ruby and Node. Rails can be installed as ordinary gem.
@@ -33,6 +35,7 @@ rvm use 2.3.1 --default         # use it and make it default
 rvm list                        # check
 
 gem install rails               # download and install latest stable Rails
+gem install foreman             # download and install Foreman
 ```
 
 Then we need to create a fresh Rails application as following:
@@ -69,7 +72,7 @@ update dependencies and generate empty app via `react_on_rails:install`. If you
 ```
 bundle
 rails generate react_on_rails:install
-bundle && npm install
+bundle && yarn
 ```
 
 ![03](https://cloud.githubusercontent.com/assets/20628911/17464918/3c2c1f00-5cf2-11e6-9525-7b2e15659e01.png)
@@ -82,14 +85,13 @@ foreman start -f Procfile.dev
 
 ![04](https://cloud.githubusercontent.com/assets/20628911/17464921/3c2fdb40-5cf2-11e6-9343-6afa53593a70.png)
 
-
 Visit http://localhost:3000/hello_world and see your **React On Rails** app running!
 
 ![05](https://cloud.githubusercontent.com/assets/20628911/17464920/3c2e8ae2-5cf2-11e6-9e30-5ec5f9e2cbc6.png)
 
 ### Custom IP & PORT setup (Cloud9 example)
 
-In case you are running some custom setup with different IP or PORT you should also edit Procfile.dev. For example to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080
+In case you are running some custom setup with different IP or PORT you should also edit Procfile.dev. For example to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080. The default generated file `Procfile.dev` uses `-p 3000`.
 
 ``` Procfile.dev
 web: rails s -p 8080 -b 0.0.0.0
@@ -192,4 +194,4 @@ Here it is:
 * [Source code for this sample app](https://github.com/dzirtusss/hello-react-on-rails)
 * [Live on Heroku](https://hello-react-on-rails.herokuapp.com/)
 
-Feedback is greatly appreciated! As are stars on github!
+Feedback is greatly appreciated! As are stars on github! If you want personalized help, don't hesitate to get in touch with us at [contact@shakacode.com](mailto:contact@shakacode.com).

data/lib/generators/USAGE

@@ -11,13 +11,13 @@ can pass the redux option if you'd like to have redux setup for you automaticall
 
 * Node
 
-    Passing the --node generator option sets up the necessary files for node to render the react_components. 
+    Passing the --node generator option sets up the necessary files for node to render the react_components.
 
 *******************************************************************************
 
 After running the generator, you will want to:
 
-    bundle && npm i
+    bundle && yarn
 
 Then you may run
 

data/lib/generators/react_on_rails/base_generator.rb

@@ -138,9 +138,9 @@ Rails.application.config.assets.paths << Rails.root.join("app", "assets", "webpa
 
           What to do next:
 
-            - Ensure your bundle and npm are up to date.
+            - Ensure your bundle and yarn installs of dependencies are up to date.
 
-                bundle && npm i
+                bundle && yarn
 
             - Run the foreman command to start the rails server and run webpack in watch mode.
 

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -30,7 +30,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:../../../..",')
         File.open(package_json, "w+") { |f| f.puts new_contents }
       end
 

data/lib/generators/react_on_rails/install_generator.rb

@@ -64,9 +64,9 @@ module ReactOnRails
       end
 
       def missing_npm?
-        return false unless ReactOnRails::Utils.running_on_windows? ? `where npm`.blank? : `which npm`.blank?
-        error = "npm is required. Please install it before continuing. "
-        error << "https://www.npmjs.com/"
+        return false unless ReactOnRails::Utils.running_on_windows? ? `where yarn`.blank? : `which yarn`.blank?
+        error = "yarn is required. Please install it before continuing. "
+        error << "https://yarnpkg.com/en/docs/install"
         GeneratorMessages.add_error(error)
         true
       end

data/lib/generators/react_on_rails/templates/base/base/Procfile.dev.tt

@@ -1,2 +1,2 @@
 web: rails s -p 3000
-client: sh -c 'rm app/assets/webpack/* || true && cd client && npm run build:development'
+client: sh -c 'rm app/assets/webpack/* || true && cd client && yarn run build:development'

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

@@ -16,13 +16,13 @@ ReactOnRails.configure do |config|
   config.server_bundle_js_file = "webpack-bundle.js"
 
   # If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
-  # with rspec then this controls what npm command is run
+  # with rspec then this controls what yarn command is run
   # to automatically refresh your webpack assets on every test run.
-  config.npm_build_test_command = "npm run build:test"
+  config.npm_build_test_command = "yarn run build:test"
 
   # This configures the script to run to build the production assets by webpack. Set this to nil
   # if you don't want react_on_rails building this file for you.
-  config.npm_build_production_command = "npm run build:production"
+  config.npm_build_production_command = "yarn run build:production"
 
   ################################################################################
   # CLIENT RENDERING OPTIONS

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

@@ -7,7 +7,7 @@
     "npm": "4.1.1"
   },
   "scripts": {
-    "postinstall": "cd client && npm install",
+    "postinstall": "cd client && yarn install",
     "rails-server": "echo 'visit http://localhost:3000/hello_world' && foreman start -f Procfile.dev",
     "test": "rspec"
   }

data/lib/react_on_rails/test_helper.rb

@@ -19,7 +19,7 @@ module ReactOnRails
     # once per test run.
     #
     # If you do not want to be slowed down by re-compiling webpack assets from scratch every test
-    # run, you can call `npm run build:client` (and `npm run build:server` if doing server
+    # run, you can call `yarn run build:client` (and `yarn run build:server` if doing server
     # rendering) to have webpack recompile these files in the background, which will be *much*
     # faster. The helper looks for these processes and will abort recompiling if it finds them
     # to be running.

data/lib/react_on_rails/test_helper/node_process_launcher.rb

@@ -5,7 +5,7 @@ module ReactOnRails
 
       path = "#{::Rails.root}/client/node"
       puts "Launching NodeJS server at #{path}"
-      system("cd #{path} && npm start &")
+      system("cd #{path} && yarn start &")
       sleep(1)
     end
   end

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "6.6.0.alpha.1".freeze
+  VERSION = "6.6.0".freeze
 end

data/lib/react_on_rails/version_checker.rb

@@ -1,5 +1,5 @@
 module ReactOnRails
-  # Responsible for checking versions of rubygem versus npm node package
+  # Responsible for checking versions of rubygem versus yarn node package
   # against each otherat runtime.
   class VersionChecker
     attr_reader :node_package_version, :logger

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "6.6.0-alpha.1",
+  "version": "6.6.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -21,11 +21,11 @@
     "babel-types": "^6.21.0",
     "babelify": "^7.3.0",
     "blue-tape": "^1.0.0",
-    "eslint": "^3.12.2",
+    "eslint": "^3.9.1",
     "eslint-config-shakacode": "^13.2.1",
-    "eslint-plugin-import": "^2.2.0",
-    "eslint-plugin-jsx-a11y": "^3.0.2",
-    "eslint-plugin-react": "^6.8.0",
+    "eslint-plugin-import": "^2.1.0",
+    "eslint-plugin-jsx-a11y": "^2.2.3",
+    "eslint-plugin-react": "^6.6.0",
     "flow-bin": "^0.37.4",
     "jsdom": "^9.9.1",
     "react": "^15.4.1",
@@ -38,9 +38,9 @@
     "webpack": "^1.14.0"
   },
   "peerDependencies": {
+    "babel-runtime": ">= 6",
     "react": ">= 0.14",
-    "react-dom": ">= 0.14",
-    "babel-runtime": ">= 6"
+    "react-dom": ">= 0.14"
   },
   "files": [
     "node_package/lib"
@@ -48,21 +48,21 @@
   "scripts": {
     "test": "babel-tape-runner -r node_package/tests/helpers/test_helper.js node_package/tests/*.js | tap-spec",
     "clean": "rm -rf node_package/lib",
-    "prepublish": "npm run build",
+    "prepublish": "yarn run build",
     "babel": "babel --out-dir node_package/lib node_package/src",
-    "build": "npm run clean && npm run babel",
+    "build": "yarn run clean && yarn run babel",
     "build-watch": "babel --watch --out-dir node_package/lib node_package/src",
     "eslint": "eslint .",
     "flow": "flow check node_package",
-    "lint": "npm run eslint",
-    "check": "npm run lint && npm run flow && npm run test",
-    "prerelease": "npm run check && npm run clean && npm run build",
+    "lint": "yarn run eslint && yarn run flow",
+    "check": "yarn run lint && yarn run flow && yarn run test",
+    "prerelease": "yarn run check && yarn run clean && yarn run build",
     "release:patch": "node_package/scripts/release patch",
     "release:minor": "node_package/scripts/release minor",
     "release:major": "node_package/scripts/release major",
     "dummy:install": "rake dummy_apps",
     "dummy:spec": "rake run_rspec:dummy",
-    "local": "echo 'Be sure to run npm run dummy:install' && npm run build && cd spec/dummy && foreman start"
+    "local": "echo 'Be sure to run yarn run dummy:install' && yarn run build && cd spec/dummy && foreman start"
   },
   "repository": {
     "type": "git",

data/rakelib/dummy_apps.rake

@@ -5,13 +5,13 @@ namespace :dummy_apps do
   task :dummy_app do
     dummy_app_dir = File.join(gem_root, "spec/dummy")
     bundle_install_in(dummy_app_dir)
-    sh_in_dir(dummy_app_dir, "npm install")
+    sh_in_dir(dummy_app_dir, "yarn install --mutex network")
   end
 
   task :dummy_app_with_turbolinks_5 do
     dummy_app_dir = File.join(gem_root, "spec/dummy")
     bundle_install_with_turbolinks_5_in(dummy_app_dir)
-    sh_in_dir(dummy_app_dir, "npm install")
+    sh_in_dir(dummy_app_dir, "yarn install --mutex network")
   end
 
   task dummy_apps: [:dummy_app, :node_package] do

data/rakelib/example_type.rb

@@ -115,7 +115,7 @@ module ReactOnRails
       end
 
       # generated files plus explicitly included files resulting from running
-      # bundle install, npm install, and generating the webpack bundles
+      # bundle install, yarn, and generating the webpack bundles
       def prepared_files
         generated_files
           .include(webpack_bundles)
@@ -129,7 +129,7 @@ module ReactOnRails
 
       # Assumes we are inside client folder
       def build_webpack_bundles_shell_commands
-        webpack_command = File.join("$(npm bin)", "webpack")
+        webpack_command = File.join("$(yarn bin)", "webpack")
         shell_commands = []
         shell_commands << "#{webpack_command} --config webpack.config.js"
       end

data/rakelib/examples.rake

@@ -43,7 +43,7 @@ namespace :examples do
     # NPM INSTALL
     task example_type.npm_install_task_name_short => example_type.package_json do
       unless uptodate?(example_type.node_modules_dir, [example_type.source_package_json])
-        sh_in_dir(example_type.client_dir, "npm install")
+        sh_in_dir(example_type.client_dir, "yarn install --mutex network")
       end
     end
 
@@ -71,7 +71,7 @@ namespace :examples do
     end
 
     # PREPARE
-    desc "Prepares #{example_type.name_pretty} (generates example, `npm install`s, and generates webpack bundles)"
+    desc "Prepares #{example_type.name_pretty} (generates example, `yarn`s, and generates webpack bundles)"
     multitask example_type.prepare_task_name_short => example_type.prepared_files do
       Rake::Task["node_package"].invoke
     end

data/rakelib/lint.rake

@@ -20,12 +20,12 @@ namespace :lint do
 
   desc "Run eslint as shell"
   task :eslint do
-    sh_in_dir(gem_root, "npm run eslint")
+    sh_in_dir(gem_root, "yarn run eslint")
   end
 
   desc "Run flow from shell"
   task :flow do
-    sh_in_dir(gem_root, "npm run flow")
+    sh_in_dir(gem_root, "yarn run flow")
   end
 
   desc "Run all eslint, flow, rubocop linters. Skip ruby-lint and scss"

data/rakelib/node_package.rake

@@ -3,7 +3,7 @@ include ReactOnRails::TaskHelpers
 
 namespace :node_package do
   task :build do
-    sh "npm run build"
+    sh "yarn run build"
   end
 end
 

data/rakelib/release.rake

@@ -7,12 +7,12 @@ require_relative File.join(gem_root, "lib", "react_on_rails", "utils")
 desc("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
+It will be automatically converted to a valid yarn 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`).
+versions such as `3.0.0.beta.1` (yarn version would be `3.0.0-beta.1`).
 
 This task depends on the gem-release (ruby gem) and release-it (node package)
-which are installed via `bundle install` and `npm install`
+which are installed via `bundle install` and `yarn`
 
 1st argument: The new version in rubygem format (no dashes). Pass no argument to
               automatically perform a patch version bump.
@@ -54,8 +54,8 @@ task :release, [:gem_version, :dry_run, :tools_install] do |_t, args|
   # Stage changes so far
   sh_in_dir(gem_root, "git add .")
 
-  # Will bump the npm version, commit, tag the commit, push to repo, and release on npm
-  release_it_command = "$(npm bin)/release-it --non-interactive --npm.publish"
+  # Will bump the yarn version, commit, tag the commit, push to repo, and release on yarn
+  release_it_command = "$(yarn bin)/release-it --non-interactive --npm.publish"
   release_it_command << " --dry-run --verbose" if is_dry_run
   release_it_command << " #{npm_version}" unless npm_version.strip.empty?
   sh_in_dir(gem_root, release_it_command)

data/rakelib/run_rspec.rake

@@ -72,9 +72,9 @@ namespace :run_rspec do
   end
 end
 
-desc "js tests (same as 'npm run test')"
+desc "js tests (same as 'yarn run test')"
 task :js_tests do
-  sh "npm run test"
+  sh "yarn run test"
 end
 
 desc "Runs all tests. Run `rake -D run_rspec` to see all available test options"
@@ -109,5 +109,5 @@ end
 
 def clean_gen_assets(dir)
   path = calc_path(dir)
-  sh_in_dir(path.realpath, "npm run build:clean")
+  sh_in_dir(path.realpath, "yarn run build:clean")
 end

data/react_on_rails.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
   s.add_dependency "rainbow", "~> 2.1"
   s.add_dependency "rails", ">= 3.2"
   s.add_dependency "addressable"
-  s.add_dependency "yajl-ruby"
 
   s.add_development_dependency "bundler", "~> 1.10"
   s.add_development_dependency "rake", "~> 10.0"
@@ -43,5 +42,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "binding_of_caller"
   s.add_development_dependency "awesome_print"
   s.add_development_dependency "gem-release"
-
 end