react_on_rails 8.0.2 → 9.0.0

data/lib/react_on_rails/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# NOTE: ReactOnRails::Utils.using_webpacker? always will return false when called here.
+
 module ReactOnRails
   def self.configure
     yield(configuration)
@@ -24,7 +26,7 @@ module ReactOnRails
 
     raise "Error configuring /config/react_on_rails.rb: invalid value for `config.i18n_dir`. "\
         "Directory does not exist: #{@configuration.i18n_dir}. Set to value to nil or comment it "\
-        "out if not using this i18n with React on Rails."
+        "out if not using the React on Rails i18n feature."
   end
 
   def self.check_i18n_yml_directory_exists
@@ -59,7 +61,7 @@ module ReactOnRails
   def self.ensure_webpack_generated_files_exists
     return unless @configuration.webpack_generated_files.empty?
 
-    files = ["webpack-bundle.js"]
+    files = ["hello-world-bundle.js"]
     if @configuration.server_bundle_js_file.present?
       files << @configuration.server_bundle_js_file
     end
@@ -81,6 +83,7 @@ module ReactOnRails
 
   def self.configuration
     @configuration ||= Configuration.new(
+      node_modules_location: "",
       generated_assets_dirs: nil,
 
       # generated_assets_dirs is deprecated
@@ -97,43 +100,45 @@ module ReactOnRails
       skip_display_none: nil,
 
       # skip_display_none is deprecated
-      webpack_generated_files: [],
+      webpack_generated_files: %w[manifest.json],
       rendering_extension: nil,
-      server_render_method: "",
+      server_render_method: "ExecJS",
       symlink_non_digested_assets_regex: nil,
-      npm_build_test_command: "",
+      build_test_command: "",
       i18n_dir: "",
       i18n_yml_dir: "",
-      npm_build_production_command: ""
+      build_production_command: ""
     )
   end
 
   class Configuration
-    attr_accessor :server_bundle_js_file, :prerender, :replay_console,
+    attr_accessor :node_modules_location, :server_bundle_js_file, :prerender, :replay_console,
                   :trace, :development_mode,
                   :logging_on_server, :server_renderer_pool_size,
                   :server_renderer_timeout, :skip_display_none, :raise_on_prerender_error,
                   :generated_assets_dirs, :generated_assets_dir,
-                  :webpack_generated_files, :rendering_extension, :npm_build_test_command,
-                  :npm_build_production_command,
+                  :webpack_generated_files, :rendering_extension, :build_test_command,
+                  :build_production_command,
                   :i18n_dir, :i18n_yml_dir,
                   :server_render_method, :symlink_non_digested_assets_regex
 
-    def initialize(server_bundle_js_file: nil, prerender: nil, replay_console: nil,
+    def initialize(node_modules_location: "", 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,
+                   server_renderer_timeout: nil, raise_on_prerender_error: true,
                    skip_display_none: nil, generated_assets_dirs: nil,
                    generated_assets_dir: nil, webpack_generated_files: nil,
-                   rendering_extension: nil, npm_build_test_command: nil,
-                   npm_build_production_command: nil,
+                   rendering_extension: nil, build_test_command: nil,
+                   build_production_command: nil,
                    i18n_dir: nil, i18n_yml_dir: nil,
-                   server_render_method: nil, symlink_non_digested_assets_regex: nil)
+                   server_render_method: "ExecJS", symlink_non_digested_assets_regex: nil)
+      self.node_modules_location = node_modules_location
       self.server_bundle_js_file = server_bundle_js_file
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
-      self.npm_build_test_command = npm_build_test_command
-      self.npm_build_production_command = npm_build_production_command
+      self.build_test_command = build_test_command
+      self.build_production_command = build_production_command
       self.i18n_dir = i18n_dir
       self.i18n_yml_dir = i18n_yml_dir
 

data/lib/react_on_rails/git_utils.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require "English"
+
 module ReactOnRails
   module GitUtils
     def self.uncommitted_changes?(message_handler)
-      return false if ENV["COVERAGE"]
+      return false if ENV["COVERAGE"] == "true"
       status = `git status --porcelain`
-      return false if status.empty?
-      error = "You have uncommitted code. Please commit or stash your changes before continuing"
+      return false if $CHILD_STATUS.success? && status.empty?
+      error = if !$CHILD_STATUS.success?
+                "You do not have Git installed. Please install Git, and commit your changes before continuing"
+              else
+                "You have uncommitted code. Please commit or stash your changes before continuing"
+              end
       message_handler.add_error(error)
       true
     end

data/lib/react_on_rails/prerender_error.rb

@@ -8,24 +8,30 @@ module ReactOnRails
                    js_code: nil, console_messages: nil)
       message = "ERROR in SERVER PRERENDERING\n".dup
       if err
-        message << <<~MSG
-          Encountered error: \"#{err}\"
+        # rubocop:disable Layout/IndentHeredoc
+        message << <<-MSG
+Encountered error: \"#{err}\"
         MSG
+        # rubocop:enable Layout/IndentHeredoc
         backtrace = err.backtrace.join("\n")
       else
         backtrace = nil
       end
-      message << <<~MSG
-        when prerendering #{component_name} with props: #{props}
-        js_code was:
-        #{js_code}
+      # rubocop:disable Layout/IndentHeredoc
+      message << <<-MSG
+when prerendering #{component_name} with props: #{props}
+js_code was:
+#{js_code}
       MSG
+      # rubocop:enable Layout/IndentHeredoc
 
       if console_messages
-        message << <<~MSG
-          console messages:
-          #{console_messages}
+        # rubocop:disable Layout/IndentHeredoc
+        message << <<-MSG
+console messages:
+#{console_messages}
         MSG
+        # rubocop:enable Layout/IndentHeredoc
       end
 
       super([message, backtrace].compact.join("\n"))

data/lib/react_on_rails/server_rendering_pool/exec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "open-uri"
+
 module ReactOnRails
   module ServerRenderingPool
     # This implementation of the rendering pool uses ExecJS to execute javasript code
@@ -14,11 +16,21 @@ module ReactOnRails
 
       def self.reset_pool_if_server_bundle_was_modified
         return unless ReactOnRails.configuration.development_mode
-        file_mtime = File.mtime(ReactOnRails::Utils.server_bundle_js_file_path)
-        @server_bundle_timestamp ||= file_mtime
-        return if @server_bundle_timestamp == file_mtime
+
+        server_bundle_js_file_path = ReactOnRails::Utils.server_bundle_js_file_path
+
+        if Webpacker.dev_server.running?
+          return if @last_loaded_server_bundle == server_bundle_js_file_path
+          @last_loaded_server_bundle = server_bundle_js_file_path
+        else
+          # we're not hashing the server name and we can use the mtime
+          file_mtime = File.mtime(server_bundle_js_file_path)
+          @server_bundle_timestamp ||= file_mtime
+          return if @server_bundle_timestamp == file_mtime
+          @server_bundle_timestamp = file_mtime
+        end
+
         ReactOnRails::ServerRenderingPool.reset_pool
-        @server_bundle_timestamp = file_mtime
       end
 
       # js_code: JavaScript expression that returns a string.
@@ -83,14 +95,15 @@ module ReactOnRails
 
           server_js_file = ReactOnRails::Utils.server_bundle_js_file_path
 
-          unless File.exist?(server_js_file)
+          # bundle_js_code = File.read(server_js_file)
+          begin
+            bundle_js_code = open(server_js_file, &:read)
+          rescue => e
             msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be "\
                 "read. You may set the server_bundle_js_file in your configuration to be \"\" to "\
-                "avoid this warning"
+                "avoid this warning.\nError is: #{e}"
             raise msg
           end
-
-          bundle_js_code = File.read(server_js_file)
           # rubocop:disable Layout/IndentHeredoc
           base_js_code = <<-JS
 #{console_polyfill}

data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb

@@ -50,7 +50,7 @@ Detected the following stale generated files:
   #{stale_files.join("\n  ")}
 
 React on Rails will ensure your JavaScript generated files are up to date, using your
-/client level package.json `#{ReactOnRails.configuration.npm_build_test_command}` command.
+`#{ReactOnRails::Utils.prepend_cd_node_modules_directory(ReactOnRails.configuration.build_test_command)}` command.
 
         MSG
         # rubocop:enable Layout/IndentHeredoc

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -8,7 +8,9 @@ module ReactOnRails
       def compile_assets
         puts "\nBuilding Webpack assets..."
 
-        cmd = "cd client && #{ReactOnRails.configuration.npm_build_test_command}"
+        cmd = ReactOnRails::Utils.prepend_cd_node_modules_directory(
+          ReactOnRails.configuration.build_test_command
+        )
 
         ReactOnRails::Utils.invoke_and_exit_if_failed(cmd, "Error in building webpack assets!")
 

data/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb

@@ -10,22 +10,24 @@ module ReactOnRails
   module TestHelper
     class WebpackAssetsStatusChecker
       include Utils::Required
-      # client_dir is typically /client, where all client files go
-      attr_reader :client_dir, :generated_assets_dir
+      # source_path is typically configured in the webpacker.yml file
+      # for `source_path`
+      # or for legacy React on Rails, it's /client, where all client files go
+      attr_reader :source_path, :generated_assets_dir
 
       def initialize(
         generated_assets_dir: required("generated_assets_dir"),
-        client_dir: required("client_dir"),
+        source_path: required("source_path"),
         webpack_generated_files: required("webpack_generated_files")
       )
         @generated_assets_dir = generated_assets_dir
-        @client_dir = client_dir
+        @source_path = source_path
         @webpack_generated_files = webpack_generated_files
       end
 
       def stale_generated_webpack_files
-        manifest_needed = ReactOnRails::Utils.using_webpacker_lite? &&
-                          !WebpackerLite::Manifest.exist?
+        manifest_needed = ReactOnRails::Utils.using_webpacker? &&
+                          !ReactOnRails::Utils.manifest_exists?
 
         return ["manifest.json"] if manifest_needed
 
@@ -53,13 +55,15 @@ module ReactOnRails
           webpack_generated_files = @webpack_generated_files.map do |bundle_name|
             ReactOnRails::Utils.bundle_js_file_path(bundle_name)
           end
+
           if webpack_generated_files.present?
             webpack_generated_files
           else
             file_list = make_file_list(make_globs(generated_assets_dir)).to_ary
             puts "V" * 80
             puts "Please define config.webpack_generated_files (array) so the test helper knows "\
-            "which files are required."
+            "which files are required. If you are using webpacker, you typically need to only "\
+            "include 'manifest.json'."
             puts "Detected the possible following files to check for webpack compilation in "\
               "#{generated_assets_dir}"
             puts file_list.join("\n")
@@ -70,7 +74,7 @@ module ReactOnRails
       end
 
       def client_files
-        @client_files ||= make_file_list(make_globs(client_dir)).to_ary
+        @client_files ||= make_file_list(make_globs(source_path)).to_ary
       end
 
       def make_globs(dirs)

data/lib/react_on_rails/test_helper.rb

@@ -44,26 +44,27 @@ module ReactOnRails
     # an example of usage.
     #
     # Typical usage passes all params as nil defaults.
-    # webpack_assets_status_checker: provide: `up_to_date?`, `whats_not_up_to_date`, `client_dir`
+    # webpack_assets_status_checker: provide: `up_to_date?`, `whats_not_up_to_date`, `source_path`
     #                         defaults to ReactOnRails::TestHelper::WebpackAssetsStatusChecker
     # webpack_assets_compiler: provide one method: `def compile`
     #                         defaults to ReactOnRails::TestHelper::WebpackAssetsCompiler
-    # client_dir and generated_assets_dir are passed into the default webpack_assets_status_checker if you
+    # source_path and generated_assets_dir are passed into the default webpack_assets_status_checker if you
     #                        don't provide one.
     # webpack_generated_files List of files to check for up-to-date-status, defaulting to
     #                        webpack_generated_files in your configuration
     def self.ensure_assets_compiled(webpack_assets_status_checker: nil,
                                     webpack_assets_compiler: nil,
-                                    client_dir: nil,
+                                    source_path: nil,
                                     generated_assets_dir: nil,
                                     webpack_generated_files: nil)
+      ReactOnRails::Utils.check_manifest_not_cached
       if webpack_assets_status_checker.nil?
-        client_dir ||= Rails.root.join("client")
-        generated_assets_dir ||= ReactOnRails.configuration.generated_assets_dir
+        source_path ||= ReactOnRails::Utils.source_path
+        generated_assets_dir ||= ReactOnRails::Utils.generated_assets_dir
         webpack_generated_files ||= ReactOnRails.configuration.webpack_generated_files
 
         webpack_assets_status_checker ||=
-          WebpackAssetsStatusChecker.new(client_dir: client_dir,
+          WebpackAssetsStatusChecker.new(source_path: source_path,
                                          generated_assets_dir: generated_assets_dir,
                                          webpack_generated_files: webpack_generated_files)
 

data/lib/react_on_rails/utils.rb

@@ -21,7 +21,6 @@ module ReactOnRails
     # Wraps message and makes it colored.
     # Pass in the msg and color as a symbol.
     def self.wrap_message(msg, color = :red)
-      # binding.pry
       wrapper_line = ("=" * 80).to_s
       # rubocop:disable Layout/IndentHeredoc
       fenced_msg = <<-MSG
@@ -62,25 +61,33 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
     end
 
     def self.server_bundle_js_file_path
-      bundle_js_file_path(ReactOnRails.configuration.server_bundle_js_file)
+      # 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
+      return @server_bundle_path if @server_bundle_path && !Rails.env.development?
+
+      bundle_name = ReactOnRails.configuration.server_bundle_js_file
+      @server_bundle_path = begin
+        bundle_js_file_path(bundle_name)
+      rescue Webpacker::Manifest::MissingEntryError
+        Rails.root.join(File.join(Webpacker.config.public_output_path, bundle_name)).to_s
+      end
     end
 
-    # TODO: conturbo Write Test for this, with BOTH webpacker_lite installed and not, and
-    # with case for webpacker_lite, but server file is not in the file
     def self.bundle_js_file_path(bundle_name)
-      # For testing outside of Rails app
-
-      if using_webpacker_lite? && WebpackerLite::Manifest.lookup(bundle_name)
-        # If using webpacker_lite gem
-        public_subdir_hashed_file_name = ActionController::Base.helpers.asset_pack_path(bundle_name)
-        return File.join("public", public_subdir_hashed_file_name)
+      if using_webpacker?
+        return bundle_name if bundle_name == "manifest.json"
+        bundle_js_file_path_from_webpacker(bundle_name)
+      else
+        # Default to the non-hashed name in the specified output directory, which, for legacy
+        # React on Rails, this is the output directory picked up by the asset pipeline.
+        File.join(ReactOnRails.configuration.generated_assets_dir, bundle_name)
       end
-
-      File.join(ReactOnRails.configuration.generated_assets_dir, bundle_name)
-    end
-
-    def self.using_webpacker_lite?
-      ActionController::Base.helpers.respond_to?(:asset_pack_path)
     end
 
     def self.running_on_windows?
@@ -108,5 +115,59 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
         raise ArgumentError, "#{arg_name} is required"
       end
     end
+
+    def self.prepend_cd_node_modules_directory(cmd)
+      return cmd unless ReactOnRails.configuration.node_modules_location.present?
+      "cd #{ReactOnRails.configuration.node_modules_location} && #{cmd}"
+    end
+
+    def self.source_path
+      using_webpacker? ? webpacker_source_path : ReactOnRails.configuration.node_modules_location
+    end
+
+    def self.generated_assets_dir
+      using_webpacker? ? webpacker_public_output_path : ReactOnRails.configuration.generated_assets_dir
+    end
+
+    ###########################################################################
+    # WEBPACKER WRAPPERS
+    ###########################################################################
+    def self.using_webpacker?
+      ActionController::Base.helpers.respond_to?(:asset_pack_path)
+    end
+
+    def self.bundle_js_file_path_from_webpacker(bundle_name)
+      hashed_bundle_name = Webpacker.manifest.lookup(bundle_name)
+      if Webpacker.dev_server.running?
+        result = "#{Webpacker.dev_server.protocol}://#{Webpacker.dev_server.host_with_port}#{hashed_bundle_name}"
+        result
+      else
+        # Next line will throw if the file or manifest does not exist
+        Rails.root.join(File.join("public", hashed_bundle_name)).to_s
+      end
+    end
+
+    def self.webpacker_source_path
+      Webpacker.config.source_path
+    end
+
+    def self.webpacker_public_output_path
+      Webpacker.config.public_output_path
+    end
+
+    def self.manifest_exists?
+      Webpacker.config.public_manifest_path.exist?
+    end
+
+    def self.check_manifest_not_cached
+      return unless using_webpacker? && Webpacker.config.cache_manifest?
+      msg = <<-MSG.strip_heredoc
+          ERROR: you have enabled cache_manifest in the #{Rails.env} env when using the
+          ReactOnRails::TestHelper.configure_rspec_to_compile_assets helper
+          To fix this: edit your config/webpacker.yml file and set cache_manifest to false for test.
+      MSG
+      puts wrap_message(msg)
+      exit!
+    end
   end
 end

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "8.0.2"
+  VERSION = "9.0.0"
 end

data/lib/react_on_rails/version_checker.rb

@@ -36,7 +36,8 @@ module ReactOnRails
             "                     gem: #{gem_version}\n" \
             "            node package: #{node_package_version.raw}\n" \
             "Ensure the installed version of the gem is the same as the version of \n"\
-            "your installed node package."
+            "your installed node package.\n"\
+            "Run `#{ReactOnRails::Utils.prepend_cd_node_modules_directory('yarn add react-on-rails')}`"
       raise msg
     end
 

data/lib/tasks/assets.rake

@@ -50,12 +50,20 @@ namespace :react_on_rails do
   namespace :assets do
     desc <<-DESC.strip_heredoc
       Compile assets with webpack
-      Uses command defined with ReactOnRails.configuration.npm_build_production_command
-      sh "cd client && `ReactOnRails.configuration.npm_build_production_command`"
+      Uses command defined with ReactOnRails.configuration.build_production_command
+
+      sh "#{ReactOnRails::Utils.prepend_cd_node_modules_directory('<ReactOnRails.configuration.build_production_command>')}"
     DESC
     task webpack: :locale do
-      if ReactOnRails.configuration.npm_build_production_command.present?
-        sh "cd client && #{ReactOnRails.configuration.npm_build_production_command}"
+      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
       end
     end
   end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "8.0.2",
+  "version": "9.0.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -8,37 +8,37 @@
   },
   "devDependencies": {
     "babel-cli": "^6.24.1",
-    "babel-core": "^6.24.1",
-    "babel-loader": "^6.4.1",
+    "babel-core": "^6.25.0",
+    "babel-loader": "^7.1.1",
     "babel-plugin-react-transform": "^2.0.2",
     "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-es2015": "^6.24.1",
     "babel-preset-react": "^6.24.1",
     "babel-preset-stage-2": "^6.24.1",
-    "babel-runtime": "^6.23.0",
+    "babel-runtime": "^6.25.0",
     "babel-tape-runner": "^2.0.1",
-    "babel-types": "^6.24.1",
+    "babel-types": "^6.25.0",
     "babelify": "^7.3.0",
     "blue-tape": "^1.0.0",
-    "create-react-class": "^15.5.2",
+    "create-react-class": "^15.6.0",
     "eslint": "^3.19.0",
-    "eslint-config-shakacode": "^14.1.1",
-    "eslint-plugin-import": "^2.2.0",
-    "eslint-plugin-jsx-a11y": "^4.0.0",
-    "eslint-plugin-react": "^6.10.3",
-    "flow-bin": "^0.43.1",
-    "jsdom": "^9.12.0",
-    "prop-types": "^15.5.7",
-    "react": "^15.5.4",
-    "react-dom": "^15.5.4",
+    "eslint-config-shakacode": "^15.0.0",
+    "eslint-plugin-import": "^2.6.1",
+    "eslint-plugin-jsx-a11y": "^5.1.1",
+    "eslint-plugin-react": "^7.1.0",
+    "flow-bin": "^0.51.1",
+    "jsdom": "^11.1.0",
+    "prop-types": "^15.5.10",
+    "react": "^15.6.1",
+    "react-dom": "^15.6.1",
     "react-transform-hmr": "^1.0.4",
-    "redux": "^3.6.0",
-    "release-it": "^2.7.1",
+    "redux": "^3.7.2",
+    "release-it": "^2.8.2",
     "tap-spec": "^4.1.1",
-    "tape": "^4.6.3",
-    "webpack": "^2.3.3",
-    "webpack-manifest-plugin": "^1.1.0"
+    "tape": "^4.7.0",
+    "webpack": "^3.4.1",
+    "webpack-manifest-plugin": "^1.2.1"
   },
   "peerDependencies": {
     "babel-runtime": ">= 6",
@@ -85,5 +85,9 @@
   "bugs": {
     "url": "https://github.com/shakacode/react_on_rails/issues"
   },
-  "homepage": "https://github.com/shakacode/react_on_rails#readme"
+  "homepage": "https://github.com/shakacode/react_on_rails#readme",
+  "dependencies": {
+    "react-on-rails": "^9.0.0-beta.12",
+    "react-redux": "^5.0.6"
+  }
 }

data/rakelib/dummy_apps.rake

@@ -14,6 +14,15 @@ 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