react_on_rails 12.0.2 → 12.1.0

data/docs/{additional-reading → rails}/convert-rails-5-api-only-app.md

@@ -16,4 +16,4 @@ Rails will start creating the app and will skip the files you have already creat
 3. If it is removeing some of your code then press "n" and add all additions manually
 ```
 
-3. Run `bundle install` and follow [the instructions for installing into an existing Rails app](../basics/installation-into-an-existing-rails-app.md).*
+3. Run `bundle install` and follow [the instructions for installing into an existing Rails app](https://www.shakacode.com/react-on-rails/docs/basics/installation-into-an-existing-rails-app)

data/docs/testimonials/testimonials.md

@@ -1,17 +1,17 @@
 # Testimonials
-# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./hvmn.md)
+# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](https://www.shakacode.com/react-on-rails/docs/testimonials/hvmn)
 
 > The price we paid for the consultation + the React on Rails pro license has already been made back a couple of times from hosting fees alone. The entire process was super hands off, and our core team was able to focus on shipping new feature during that sprint.
 
-Full writeup [here](./hvmn.md).
+Full writeup [here](https://www.shakacode.com/react-on-rails/docs/testimonials/hvmn).
 
 ---
 
-# [Leora from ResortPass](./resortpass.md), December 10, 2018
+# [Leora from ResortPass](https://www.shakacode.com/react-on-rails/docs/testimonials/resortpass), December 10, 2018
 
-Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds. 
+Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds.
 
-Full writeup [here](./testimonials/resortpass.md).
+Full writeup [here](https://www.shakacode.com/react-on-rails/docs/testimonials/resortpass).
 
 ---
 
@@ -25,4 +25,4 @@ From Kyle Maune of Cooper Aerial, May 4, 2018
 
 ![image](https://user-images.githubusercontent.com/1118459/40891236-9b0b406e-671d-11e8-80ee-c026dbd1d5a2.png)
 
-For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](KUDOS.md).
+For more testimonials, see [Live Projects](https://github.com/shakacode/react_on_rails/tree/master/PROJECTS.md) and [Kudos](https://github.com/shakacode/react_on_rails/tree/master/KUDOS.md).

data/lib/generators/react_on_rails/base_generator.rb

@@ -43,7 +43,14 @@ module ReactOnRails
       end
 
       def add_yarn_dependencies
-        run "yarn add react-on-rails --exact"
+        major_minor_patch_only = /\A\d+\.\d+\.\d+\z/.freeze
+        if ReactOnRails::VERSION.match?(major_minor_patch_only)
+          run "yarn add react-on-rails@#{ReactOnRails::VERSION} --exact"
+        else
+          # otherwise add latest
+          puts "Adding the lastest react-on-rails NPM module. Double check this is correct in package.json"
+          run "yarn add react-on-rails --exact"
+        end
       end
 
       def append_to_spec_rails_helper

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -25,7 +25,7 @@ module ReactOnRails
       end
 
       def copy_tests
-        %w[spec/features/hello_world_spec.rb].each { |file| copy_file(file) }
+        %w[spec/system/hello_world_spec.rb].each { |file| copy_file(file) }
       end
 
       def add_test_related_gems_to_gemfile

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

@@ -13,9 +13,11 @@ require_relative "spec_helper"
 require "rspec/rails"
 require "capybara/rspec"
 require "capybara/rails"
-Capybara.javascript_driver = :selenium_chrome
 Capybara.register_driver :selenium_chrome do |app|
-  Capybara::Selenium::Driver.new(app, browser: :chrome)
+  options = Selenium::WebDriver::Chrome::Options.new
+  options.add_argument("--headless")
+  options.add_argument("--disable-gpu")
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
 end
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
@@ -38,6 +40,10 @@ end
 # ActiveRecord::Migration.maintain_test_schema!
 
 RSpec.configure do |config|
+  config.before(:each, type: :system, js: true) do
+    driven_by :selenium_chrome
+  end
+
   # Ensure that if we are running js tests, we are using latest webpack assets
   # This will use the defaults of :js and :server_rendering meta tags
   ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)

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

@@ -17,7 +17,7 @@ if ENV["COVERAGE"] == "true"
 
     # Don't report anything that has "spec" in the path
     add_filter do |src|
-      src.filename =~ %r{\/spec\/}
+      src.filename.include?("/spec/")
     end
   end
 end

data/lib/generators/react_on_rails/templates/dev_tests/spec/{features → system}/hello_world_spec.rb

@@ -2,8 +2,8 @@
 
 require_relative "../rails_helper"
 
-feature "Hello World", js: true do
-  scenario "the hello world example works" do
+describe "Hello World", js: true do
+  it "the hello world example works" do
     visit "/hello_world"
     expect(heading).to have_text("Hello World")
     expect(message).to have_text("Stranger")

data/lib/react_on_rails/configuration.rb

@@ -53,6 +53,7 @@ module ReactOnRails
                   :server_render_method, :random_dom_id,
                   :same_bundle_for_client_and_server
 
+    # rubocop:disable Metrics/AbcSize
     def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender: nil,
                    replay_console: nil,
                    trace: nil, development_mode: nil,
@@ -98,6 +99,7 @@ module ReactOnRails
 
       self.server_render_method = server_render_method
     end
+    # rubocop:enable Metrics/AbcSize
 
     # on ReactOnRails
     def setup_config_values

data/lib/react_on_rails/git_utils.rb

@@ -10,10 +10,10 @@ module ReactOnRails
       status = `git status --porcelain`
       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
+      error = if $CHILD_STATUS.success?
                 "You have uncommitted code. Please commit or stash your changes before continuing"
+              else
+                "You do not have Git installed. Please install Git, and commit your changes before continuing"
               end
       message_handler.add_error(error)
       true

data/lib/react_on_rails/helper.rb

@@ -32,8 +32,8 @@ module ReactOnRails
     #   Exposing the react_component_name is necessary to both a plain ReactComponent as well as
     #     a generator:
     #   See README.md for how to "register" your react components.
-    #   See spec/dummy/client/app/startup/serverRegistration.jsx and
-    #     spec/dummy/client/app/startup/ClientRegistration.jsx for examples of this
+    #   See spec/dummy/client/app/packs/server-bundle.js and
+    #     spec/dummy/client/app/packs/client-bundle.js for examples of this.
     #
     # options:
     #   props: Ruby Hash or JSON string which contains the properties to pass to the react object. Do
@@ -57,14 +57,15 @@ module ReactOnRails
       server_rendered_html = internal_result[:result]["html"]
       console_script = internal_result[:result]["consoleReplayScript"]
 
-      if server_rendered_html.is_a?(String)
+      case server_rendered_html
+      when String
         build_react_component_result_for_server_rendered_string(
           server_rendered_html: server_rendered_html,
           component_specification_tag: internal_result[:tag],
           console_script: console_script,
           render_options: internal_result[:render_options]
         )
-      elsif server_rendered_html.is_a?(Hash)
+      when Hash
         msg = <<~MSG
           Use react_component_hash (not react_component) to return a Hash to your ruby view code. See
           https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
@@ -169,7 +170,7 @@ module ReactOnRails
     def redux_store_hydration_data
       return if @registered_stores_defer_render.blank?
 
-      @registered_stores_defer_render.reduce("".dup) do |accum, redux_store_data|
+      @registered_stores_defer_render.reduce(+"") do |accum, redux_store_data|
         accum << render_redux_store_data(redux_store_data)
       end.html_safe
     end
@@ -243,7 +244,7 @@ module ReactOnRails
     # second parameter passed to both component and store Render-Functions.
     # This method can be called from views and from the controller, as `helpers.rails_context`
     #
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     def rails_context(server_side: true)
       # ALERT: Keep in sync with node_package/src/types/index.ts for the properties of RailsContext
       @rails_context ||= begin
@@ -254,8 +255,13 @@ module ReactOnRails
           i18nLocale: I18n.locale,
           i18nDefaultLocale: I18n.default_locale,
           rorVersion: ReactOnRails::VERSION,
+          # TODO: v13 just use the version if existing
           rorPro: ReactOnRails::Utils.react_on_rails_pro?
         }
+        if ReactOnRails::Utils.react_on_rails_pro?
+          result[:rorProVersion] = ReactOnRails::Utils.react_on_rails_pro_version
+        end
+
         if defined?(request) && request.present?
           # Check for encoding of the request's original_url and try to force-encoding the
           # URLs as UTF-8. This situation can occur in browsers that do not encode the
@@ -291,7 +297,7 @@ module ReactOnRails
 
       @rails_context.merge(serverSide: server_side)
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
     private
 
@@ -486,13 +492,13 @@ module ReactOnRails
     end
 
     def initialize_redux_stores
-      result = <<-JS.dup
+      result = +<<-JS
       ReactOnRails.clearHydratedStores();
       JS
 
       return result unless @registered_stores.present? || @registered_stores_defer_render.present?
 
-      declarations = "var reduxProps, store, storeGenerator;\n".dup
+      declarations = +"var reduxProps, store, storeGenerator;\n"
       all_stores = (@registered_stores || []) + (@registered_stores_defer_render || [])
 
       result << all_stores.each_with_object(declarations) do |redux_store_data, memo|

data/lib/react_on_rails/locales/base.rb

@@ -32,12 +32,12 @@ module ReactOnRails
       end
 
       def exist_files
-        @exist_files ||= files.select(&File.method(:exist?))
+        @exist_files ||= files.select { |file| File.exist?(file) }
       end
 
       def files_are_outdated
-        latest_yml = locale_files.map(&File.method(:mtime)).max
-        earliest = exist_files.map(&File.method(:mtime)).min
+        latest_yml = locale_files.map { |file| File.mtime(file) }.max
+        earliest = exist_files.map { |file| File.mtime(file) }.min
         latest_yml > earliest
       end
 

data/lib/react_on_rails/locales/to_js.rb

@@ -5,10 +5,6 @@ require "erb"
 module ReactOnRails
   module Locales
     class ToJs < Base
-      def initialize
-        super
-      end
-
       private
 
       def file_format

data/lib/react_on_rails/locales/to_json.rb

@@ -5,10 +5,6 @@ require "erb"
 module ReactOnRails
   module Locales
     class ToJson < Base
-      def initialize
-        super
-      end
-
       private
 
       def file_format

data/lib/react_on_rails/prerender_error.rb

@@ -46,7 +46,7 @@ module ReactOnRails
     private
 
     def calc_message(component_name, console_messages, err, js_code, props)
-      message = "ERROR in SERVER PRERENDERING\n".dup
+      message = +"ERROR in SERVER PRERENDERING\n"
       if err
         message << <<~MSG
           Encountered error: \"#{err}\"

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -47,6 +47,7 @@ module ReactOnRails
         # Note, js_code does not have to be based on React.
         # js_code MUST RETURN json stringify Object
         # Calling code will probably call 'html_safe' on return value before rendering to the view.
+        # rubocop:disable Metrics/CyclomaticComplexity
         def exec_server_render_js(js_code, render_options, js_evaluator = nil)
           js_evaluator ||= self
           if render_options.trace
@@ -67,16 +68,15 @@ module ReactOnRails
             console_script = result["consoleReplayScript"]
             console_script_lines = console_script.split("\n")
             console_script_lines = console_script_lines[2..-2]
-            re = /console\.(log|error)\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
-            if console_script_lines
-              console_script_lines.each do |line|
-                match = re.match(line)
-                Rails.logger.info { "[react_on_rails] #{match[:msg]}" } if match
-              end
+            re = /console\.(?:log|error)\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
+            console_script_lines&.each do |line|
+              match = re.match(line)
+              Rails.logger.info { "[react_on_rails] #{match[:msg]}" } if match
             end
           end
           result
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def trace_js_code_used(msg, js_code, file_name = "tmp/server-generated.js", force: false)
           return unless ReactOnRails.configuration.trace || force

data/lib/react_on_rails/test_helper.rb

@@ -52,6 +52,7 @@ module ReactOnRails
     #                        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
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.ensure_assets_compiled(webpack_assets_status_checker: nil,
                                     webpack_assets_compiler: nil,
                                     source_path: nil,
@@ -96,4 +97,5 @@ module ReactOnRails
       ).call
     end
   end
+  # rubocop:enable Metrics/CyclomaticComplexity
 end

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -8,7 +8,7 @@ module ReactOnRails
       def compile_assets
         if ReactOnRails.configuration.build_test_command.blank?
           msg = <<~MSG
-            You are using the React on Rails test helper. 
+            You are using the React on Rails test helper.
             Either you used:
               ReactOnRails::TestHelper.configure_rspec_to_compile_assets or
               ReactOnRails::TestHelper.ensure_assets_compiled

data/lib/react_on_rails/utils.rb

@@ -34,7 +34,7 @@ module ReactOnRails
     end
 
     def self.object_to_boolean(value)
-      [true, "true", "yes", 1, "1", "t"].include?(value.class == String ? value.downcase : value)
+      [true, "true", "yes", 1, "1", "t"].include?(value.instance_of?(String) ? value.downcase : value)
     end
 
     def self.server_rendering_is_enabled?
@@ -118,9 +118,11 @@ module ReactOnRails
       end
     end
 
+    # rubocop:disable Naming/VariableNumber
     def self.rails_version_less_than_4_1_1
       rails_version_less_than("4.1.1")
     end
+    # rubocop:enable Naming/VariableNumber
 
     module Required
       def required(arg_name)
@@ -156,15 +158,29 @@ module ReactOnRails
     end
 
     def self.gem_available?(name)
-      Gem::Specification.find_all_by_name(name).present?
+      Gem.loaded_specs[name].present?
     rescue Gem::LoadError
       false
     rescue StandardError
       Gem.available?(name).present?
     end
 
+    # Todo -- remove this for v13, as we don't need both boolean and number
     def self.react_on_rails_pro?
-      @react_on_rails_pro ||= gem_available?("react_on_rails_pro")
+      return @react_on_rails_pro if defined?(@react_on_rails_pro)
+
+      @react_on_rails_pro = gem_available?("react_on_rails_pro")
+    end
+
+    # Return an empty string if React on Rails Pro is not installed
+    def self.react_on_rails_pro_version
+      return @react_on_rails_pro_version if defined?(@react_on_rails_pro_version)
+
+      @react_on_rails_pro_version = if react_on_rails_pro?
+                                      Gem.loaded_specs["react_on_rails_pro"].version.to_s
+                                    else
+                                      ""
+                                    end
     end
 
     def self.smart_trim(str, max_length = 1000)

data/lib/react_on_rails/version.rb

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

data/lib/react_on_rails/webpacker_utils.rb

@@ -2,8 +2,12 @@
 
 module ReactOnRails
   module WebpackerUtils
+    # TODO: V13 code should be cleaned up so that the webpacker gem is required.
+    # This check should only be done at startup.
     def self.using_webpacker?
-      ReactOnRails::Utils.gem_available?("webpacker")
+      return @using_webpacker if defined?(@using_webpacker)
+
+      @using_webpacker = ReactOnRails::Utils.gem_available?("webpacker")
     end
 
     def self.webpacker_webpack_production_config_exists?

data/lib/tasks/assets.rake

@@ -6,7 +6,6 @@
 require "active_support"
 
 ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
-ENV["NODE_ENV"]  ||= "development"
 
 unless ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
   # Ensure that rails/webpacker does not call bin/webpack if we're providing
@@ -20,8 +19,8 @@ unless ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
     # VERSIONS is per the rails/webpacker clean method definition.
     # We set it very big so that it is not used, and then clean just
     # removes files older than 1 hour.
-    VERSIONS = 100_000
-    Rake::Task["webpacker:clean"].invoke(VERSIONS)
+    versions = 100_000
+    Rake::Task["webpacker:clean"].invoke(versions)
   }
 
   if Rake::Task.task_defined?("assets:precompile")
@@ -40,17 +39,27 @@ end
 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>')}"	
-      Note: This command is not automatically added to assets:precompile if the rails/webpacker	
+      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 ReactOnRails.configuration.build_production_command.present?
-        sh ReactOnRails::Utils.prepend_cd_node_modules_directory(
-          ReactOnRails.configuration.build_production_command
-        ).to_s
+      build_production_command = ReactOnRails.configuration.build_production_command
+      if build_production_command.present?
+        if build_production_command.is_a?(String)
+          sh ReactOnRails::Utils.prepend_cd_node_modules_directory(
+            build_production_command
+          ).to_s
+        elsif build_production_command.methods.include?(:call)
+          build_production_command.call
+        else
+          msg = "ReactonRails.configuration.build_production_command is improperly configured. "\
+                "Value = #{build_production_command} with class #{build_production_command.class}"
+          puts Rainbow(msg).red
+          exit!(1)
+        end
       else
         msg = <<~MSG
           React on Rails is aborting webpack compilation from task react_on_rails:assets:webpack