react_on_rails 11.2.2 → 12.0.0.pre.beta.3

data/lib/react_on_rails/utils.rb

@@ -8,7 +8,7 @@ require "active_support/core_ext/string"
 
 module ReactOnRails
   module Utils
-    TRUNCATION_FILLER = "\n... TRUNCATED ...\n".freeze
+    TRUNCATION_FILLER = "\n... TRUNCATED ...\n"
 
     # https://forum.shakacode.com/t/yak-of-the-week-ruby-2-4-pathname-empty-changed-to-look-at-file-size/901
     # return object if truthy, else return nil
@@ -24,13 +24,12 @@ module ReactOnRails
     # Pass in the msg and color as a symbol.
     def self.wrap_message(msg, color = :red)
       wrapper_line = ("=" * 80).to_s
-      # rubocop:disable Layout/IndentHeredoc
-      fenced_msg = <<-MSG
-#{wrapper_line}
-#{msg.strip}
-#{wrapper_line}
+      fenced_msg = <<~MSG
+        #{wrapper_line}
+        #{msg.strip}
+        #{wrapper_line}
       MSG
-      # rubocop:enable Layout/IndentHeredoc
+
       Rainbow(fenced_msg).color(color)
     end
 
@@ -48,14 +47,13 @@ module ReactOnRails
       unless status.success?
         stdout_msg = stdout.present? ? "\nstdout:\n#{stdout.strip}\n" : ""
         stderr_msg = stderr.present? ? "\nstderr:\n#{stderr.strip}\n" : ""
-        # rubocop:disable Layout/IndentHeredoc
-        msg = <<-MSG
-React on Rails FATAL ERROR!
-#{failure_message}
-cmd: #{cmd}
-exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
+        msg = <<~MSG
+          React on Rails FATAL ERROR!
+          #{failure_message}
+          cmd: #{cmd}
+          exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
         MSG
-        # rubocop:enable Layout/IndentHeredoc
+
         puts wrap_message(msg)
 
         # Rspec catches exit without! in the exit callbacks
@@ -72,11 +70,8 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
       # Either:
       # 1. Using same bundle for both server and client, so server bundle will be hashed in manifest
       # 2. Using a different bundle (different Webpack config), so file is not hashed, and
-      #    bundle_js_path will throw.
-      # 3. Not using webpacker, and bundle_js_path always returns
-
-      # Note, server bundle should not be in the manifest
-      # If using webpacker gem per https://github.com/rails/webpacker/issues/571
+      #    bundle_js_path will throw so the default path is used without a hash.
+      # 3. Not using webpacker, and this method returns the bundle_js_file_path
       return @server_bundle_path if @server_bundle_path && !Rails.env.development?
 
       bundle_name = ReactOnRails.configuration.server_bundle_js_file

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "11.2.2".freeze
+  VERSION = "12.0.0-beta.3"
 end

data/lib/react_on_rails/version_checker.rb

@@ -5,6 +5,7 @@ module ReactOnRails
   # against each otherat runtime.
   class VersionChecker
     attr_reader :node_package_version
+
     MAJOR_MINOR_PATCH_VERSION_REGEX = /(\d+)\.(\d+)\.(\d+)/.freeze
 
     def self.build

data/lib/react_on_rails/webpacker_utils.rb

@@ -1,16 +1,26 @@
+# frozen_string_literal: true
+
 module ReactOnRails
   module WebpackerUtils
     def self.using_webpacker?
       ReactOnRails::Utils.gem_available?("webpacker")
     end
 
+    def self.webpacker_webpack_production_config_exists?
+      webpacker_webpack_config_abs_path = File.join(Rails.root,
+                                                    "config/webpack/production.js")
+      File.exist?(webpacker_webpack_config_abs_path)
+    end
+
     def self.dev_server_running?
       return false unless using_webpacker?
 
       Webpacker.dev_server.running?
     end
 
-    # This returns either a URL for the webpack-dev-server or a file path
+    # This returns either a URL for the webpack-dev-server, non-server bundle or
+    # the hashed server bundle if using the same bundle for the client.
+    # Otherwise returns a file path.
     def self.bundle_js_uri_from_webpacker(bundle_name)
       # Note Webpacker 3.4.3 manifest lookup is inside of the public_output_path
       # [2] (pry) ReactOnRails::WebpackerUtils: 0> Webpacker.manifest.lookup("app-bundle.js")
@@ -18,7 +28,14 @@ module ReactOnRails
       # Next line will throw if the file or manifest does not exist
       hashed_bundle_name = Webpacker.manifest.lookup!(bundle_name)
 
-      if Webpacker.dev_server.running?
+      # support for hashing the server-bundle and having that built
+      # by a webpack watch process and not served by the webpack-dev-server, then we
+      # need an extra config value "same_bundle_for_client_and_server" where a value of false
+      # would mean that the bundle is created by a separate webpack watch process.
+      is_server_bundle = bundle_name == ReactOnRails.configuration.server_bundle_js_file
+
+      if Webpacker.dev_server.running? && (!is_server_bundle ||
+        ReactOnRails.configuration.same_bundle_for_client_and_server)
         "#{Webpacker.dev_server.protocol}://#{Webpacker.dev_server.host_with_port}#{hashed_bundle_name}"
       else
         File.expand_path(File.join("public", hashed_bundle_name)).to_s

data/lib/tasks/assets.rake

@@ -1,69 +1,51 @@
 # frozen_string_literal: true
 
-require "react_on_rails/assets_precompile"
-require "active_support"
-
-if defined?(Sprockets)
-  namespace :react_on_rails do
-    namespace :assets do
-      desc "Creates non-digested symlinks for the assets in the public asset dir"
-      task symlink_non_digested_assets: :"assets:environment" do
-        ReactOnRails::AssetsPrecompile.new.symlink_non_digested_assets
-      end
+# Important: The default assets:precompile is modified ONLY if the rails/webpacker webpack config
+# does not exist!
 
-      desc "Cleans all broken symlinks for the assets in the public asset dir"
-      task delete_broken_symlinks: :"assets:environment" do
-        ReactOnRails::AssetsPrecompile.new.delete_broken_symlinks
-      end
+require "active_support"
 
-      # In this task, set prerequisites for the assets:precompile task
-      desc <<-DESC.strip_heredoc
-        Create webpack assets before calling assets:environment
-        The webpack task must run before assets:environment task.
-        Otherwise Sprockets cannot find the files that webpack produces.
-        This is the secret sauce for how a Heroku deployment knows to create the webpack generated JavaScript files.
-      DESC
-      task compile_environment: :webpack do
-        Rake::Task["assets:environment"].invoke
-      end
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"]  ||= "development"
 
-      desc "Delete assets created with webpack, in the generated assetst directory (/app/assets/webpack)"
-      task clobber: :environment do
-        ReactOnRails::AssetsPrecompile.new.clobber
-      end
+unless ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
+  if Rake::Task.task_defined?("assets:precompile")
+    Rake::Task["assets:precompile"].enhance do
+      Rake::Task["react_on_rails:assets:webpack"].invoke
+      puts "Invoking task wepacker:clean from React on Rails"
+      Rake::Task["webpacker:clean"].invoke
     end
+  else
+    Rake::Task.define_task("assets:precompile" => ["react_on_rails:assets:webpack"])
   end
-
-  # These tasks run as pre-requisites of assets:precompile.
-  # Note, it's not possible to refer to ReactOnRails configuration values at this point.
-  Rake::Task["assets:precompile"]
-    .clear_prerequisites
-    .enhance([:environment, "react_on_rails:assets:compile_environment"])
-    .enhance do
-      Rake::Task["react_on_rails:assets:symlink_non_digested_assets"].invoke
-      Rake::Task["react_on_rails:assets:delete_broken_symlinks"].invoke
-    end
 end
 
 # Sprockets independent tasks
 namespace :react_on_rails do
   namespace :assets do
     desc <<-DESC.strip_heredoc
-      Compile assets with webpack
-      Uses command defined with ReactOnRails.configuration.build_production_command
-
-      sh "#{ReactOnRails::Utils.prepend_cd_node_modules_directory('<ReactOnRails.configuration.build_production_command>')}"
+      Compile assets with webpack	
+      Uses command defined with ReactOnRails.configuration.build_production_command	
+      sh "#{ReactOnRails::Utils.prepend_cd_node_modules_directory('<ReactOnRails.configuration.build_production_command>')}"	
+      Note: This command is not automatically added to assets:precompile if the rails/webpacker	
+      configuration file config/webpack/production.js exists.
     DESC
     task webpack: :locale do
-      if Rake::Task.task_defined?("webpacker:compile")
-        # TODO: Eventually, this will need reconsideration if we use any of the Webpacker compilation
-        Rake::Task["webpacker:compile"].clear
-      end
-
       if ReactOnRails.configuration.build_production_command.present?
         sh ReactOnRails::Utils.prepend_cd_node_modules_directory(
           ReactOnRails.configuration.build_production_command
         ).to_s
+      else
+        msg = <<~MSG
+          React on Rails is aborting webpack compilation from task react_on_rails:assets:webpack
+          because you do not have the `config.build_production_command` defined.
+
+          Note, this task may have run as part of `assets:precompile`. If file
+          config/webpack/production.js does not exist, React on Rails will modify
+          the default `asset:precompile` to run task `react_on_rails:assets:webpack`.
+        MSG
+        puts Rainbow(msg).red
+        exit!(1)
       end
     end
   end

data/lib/tasks/locale.rake

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require "react_on_rails/locales_to_js"
+require "react_on_rails/locales/base"
+require "react_on_rails/locales/to_js"
+require "react_on_rails/locales/to_json"
 require "active_support"
 
 namespace :react_on_rails do
@@ -10,6 +12,6 @@ namespace :react_on_rails do
     the "ReactOnRails.configuration.i18n_dir".
   DESC
   task locale: :environment do
-    ReactOnRails::LocalesToJs.new
+    ReactOnRails::Locales.compile
   end
 end

data/package-scripts.yml

@@ -1,12 +1,12 @@
 scripts:
   lint:
-    description: Run all linters (eslint, flow)
+    description: Run all linters (eslint, tsc)
     script: concurrently --prefix "[{name}]" --names "ESLINT" -c "blue,yellow,magenta,orange" "nps eslint"
 
   eslint:
     default:
       description: Run eslint.
-      script: eslint . --ext ".js,.jsx"
+      script: eslint . --ext ".js,.jsx,.ts"
     fix:
       description: Run eslint and auto-fix.
       script: nps "eslint --fix"
@@ -17,30 +17,33 @@ scripts:
   format:
     default:
       description: Format files using prettier.
-      script: concurrently --prefix "[{name}]" --names "js,json" -c "yellow,magenta,green" "nps format.js" "nps format.json"
+      script: concurrently --prefix "[{name}]" --names "ts,js,json" -c "yellow,magenta,green" "nps format.js" "nps format.json"
     listDifferent:
       description: Check that all files were formatted using prettier.
       script: |
         concurrently \
           --prefix "[{name}]" \
-          --names "js,css,json" \
-          -c "yellow,magenta,green" \
+          --names "ts,js,json" \
+          -c "yellow,magenta" \
           "nps format.js.listDifferent" \
           "nps format.json.listDifferent"
     js:
       default:
         description: Run prettier-eslint on JS.
-        script: prettier "packages/**/*.@(js|jsx)" "spec/dummy/client/app/**/*.@(js|jsx)" "webpack.config.babel.js" "webpack/**/*.js" --write
+        #script: prettier "packages/**/*.@(js|jsx)" "spec/dummy/client/app/**/*.@(js|jsx)" "webpack.config.babel.js" "webpack/**/*.js" --write
+        script: prettier "**/*.@(js|jsx)" --write
       listDifferent:
         description: Check if any JS files would change by running prettier-eslint.
-        script: prettier "**/*.@(js|jsx)" "webpack.config.babel.js" "webpack/**/*.js" --list-different
+        # script: prettier "**/*.@(js|jsx)" "webpack.config.babel.js" "webpack/**/*.js" --list-different
+        script: prettier "**/*.@(js|jsx)" --list-different
     json:
       default:
         description: Run prettier on JSON files.
         script: rm -rf packages/vm-renderer/tests/tmp && prettier "**/*.json" --write
       listDifferent:
         description: Check if any JSON files would change by running prettier-eslint.
-        script: prettier "**/*.json" "../spec/**/*.json" --list-different
+        script: prettier "**/*.json" --list-different
+
   renderer:
     description: Starts the node renderer.
     script: node renderer.js

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "11.2.2",
+  "version": "12.0.0-beta.3",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -9,70 +9,75 @@
   "devDependencies": {
     "@babel/cli": "^7.0.0",
     "@babel/core": "^7.0.0",
-    "@babel/plugin-transform-flow-strip-types": "^7.0.0",
     "@babel/plugin-transform-runtime": "^7.0.0",
+    "@babel/plugin-transform-typescript": "^7.8.7",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-react": "^7.0.0",
     "@babel/types": "^7.0.0",
+    "@types/jest": "^25.1.4",
+    "@types/node": "^13.9.0",
+    "@types/react": "^16.9.23",
+    "@types/react-dom": "^16.9.5",
+    "@types/turbolinks": "^5.2.0",
+    "@typescript-eslint/eslint-plugin": "^2.23.0",
+    "@typescript-eslint/parser": "^2.23.0",
     "babel-loader": "^8.0.2",
-    "babel-tape-runner": "^3.0.0",
     "babelify": "^10.0.0",
     "blue-tape": "^1.0.0",
     "create-react-class": "^15.6.0",
-    "eslint": "^5.7.0",
-    "eslint-config-prettier": "^3.1.0",
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.10.1",
     "eslint-config-shakacode": "^16.0.1",
     "eslint-plugin-import": "^2.6.1",
     "eslint-plugin-jsx-a11y": "^6.1.2",
     "eslint-plugin-prettier": "^3.0.0",
     "eslint-plugin-react": "^7.1.0",
-    "flow-bin": "^0.83.0",
+    "jest": "^25.1.0",
     "jsdom": "^11.1.0",
     "nps": "^5.9.3",
-    "prettier": "^1.14.3",
-    "prettier-eslint-cli": "^4.7.1",
+    "prettier": "^2.0.1",
+    "prettier-eslint-cli": "^5.0.0",
     "prop-types": "^15.5.10",
     "react": "^16.5.2",
     "react-dom": "^16.5.2",
     "react-transform-hmr": "^1.0.4",
     "redux": "^4.0.1",
     "release-it": "^8.2.0",
-    "tap-spec": "^5.0.0",
-    "tape": "^4.7.0",
+    "ts-jest": "^25.2.1",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.8.3",
     "webpack": "^3.4.1",
     "webpack-manifest-plugin": "^1.2.1"
   },
   "dependencies": {
-    "@babel/runtime-corejs2": "^7.0.0"
+    "@babel/runtime-corejs3": "^7.9.6",
+    "concurrently": "^5.1.0"
   },
   "peerDependencies": {
     "js-yaml": ">= 3.0.0",
-    "react": ">= 0.14",
-    "react-dom": ">= 0.14"
+    "react": ">= 16",
+    "react-dom": ">= 16"
   },
   "files": [
     "node_package/lib",
     "webpackConfigLoader.js"
   ],
   "scripts": {
-    "test": "babel-tape-runner -r node_package/tests/helpers/test_helper.js node_package/tests/*.js | tap-spec",
+    "test": "jest node_package/tests",
     "clean": "rm -rf node_package/lib",
+    "start": "nps",
     "prepare": "yarn run build",
-    "prepublish": "npm run prepare",
-    "babel": "babel --out-dir node_package/lib node_package/src",
-    "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": "yarn run eslint && yarn run flow",
-    "check": "yarn run lint && yarn run flow && yarn run test",
+    "build": "yarn run clean && yarn run tsc --declaration",
+    "build-watch": "yarn run clean && yarn run tsc --watch",
+    "lint": "nps eslint",
+    "check": "yarn run lint && yarn run test && yarn run type-check",
+    "type-check": "yarn run tsc --noEmit --noErrorTruncation",
     "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",
-    "install-react-on-rails": "yarn link"
+    "dummy:spec": "rake run_rspec:dummy"
   },
   "repository": {
     "type": "git",
@@ -91,9 +96,5 @@
   "bugs": {
     "url": "https://github.com/shakacode/react_on_rails/issues"
   },
-  "jest": {
-    "verbose": true,
-    "testURL": "http://localhost/"
-  },
   "homepage": "https://github.com/shakacode/react_on_rails#readme"
 }

data/rakelib/dummy_apps.rake

@@ -8,6 +8,7 @@ namespace :dummy_apps do
   task :yarn_install do
     yarn_install_cmd = "yarn install --mutex network"
     sh_in_dir(dummy_app_dir, yarn_install_cmd)
+    sh_in_dir(dummy_app_dir, "yalc link react-on-rails")
   end
 
   task dummy_app: [:yarn_install] do
@@ -15,15 +16,6 @@ namespace :dummy_apps do
     bundle_install_in(dummy_app_dir)
   end
 
-  task :dummy_no_webpacker do
-    npm_install_cmd = "npm install"
-    install_react_on_rails_cmd = "yarn run install-react-on-rails"
-    dummy_app_dir = File.join(gem_root, "spec/dummy_no_webpacker")
-    sh_in_dir(File.join(gem_root, "spec/dummy_no_webpacker/client"), npm_install_cmd)
-    sh_in_dir(dummy_app_dir, install_react_on_rails_cmd)
-    sh_in_dir(dummy_app_dir, "BUNDLE_GEMFILE=Gemfile.rails32 bundle install")
-  end
-
   task dummy_apps: %i[dummy_app node_package] do
     puts "Prepared all Dummy Apps"
   end

data/rakelib/example_type.rb

@@ -49,8 +49,10 @@ module ReactOnRails
       end
 
       # Options we pass when running `rails new` from the command-line.
+      attr_writer :rails_options
+
       def rails_options
-        "--skip-bundle --skip-spring --skip-git --skip-test-unit --skip-active-record"
+        @rails_options ||= "--skip-bundle --skip-spring --skip-git --skip-test-unit --skip-active-record"
       end
 
       %w[gen clobber npm_install build_webpack_bundles].each do |task_type|

data/rakelib/examples.rake

@@ -6,6 +6,8 @@
 # Also see example_type.rb
 
 require "yaml"
+require 'rails/version'
+
 require_relative "example_type"
 require_relative "task_helpers"
 
@@ -28,6 +30,7 @@ namespace :examples do # rubocop:disable Metrics/BlockLength
     desc "Generates #{example_type.name_pretty}"
     task example_type.gen_task_name_short => example_type.clobber_task_name do
       mkdir_p(example_type.dir)
+      example_type.rails_options += " --webpack" if Rails.version >= "5.1" && Rails.version < "6"
       sh_in_dir(examples_dir, "rails new #{example_type.name} #{example_type.rails_options}")
       sh_in_dir(example_type.dir, "touch .gitignore")
       sh_in_dir(example_type.dir, "rake webpacker:install")