react_on_rails 12.0.0 → 12.1.0

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?
@@ -71,7 +71,11 @@ module ReactOnRails
       # 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 so the default path is used without a hash.
-      # 3. Not using webpacker, and this method returns the bundle_js_file_path
+      # 3. The third option of having the server bundle hashed and a different configuration than
+      #    the client bundle is not supported for 2 reasons:
+      #    a. The webpack manifest plugin would have a race condition where the same manifest.json
+      #       is edited by both the webpack-dev-server
+      #    b. There is no good reason to hash the server bundle name.
       return @server_bundle_path if @server_bundle_path && !Rails.env.development?
 
       bundle_name = ReactOnRails.configuration.server_bundle_js_file
@@ -114,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)
@@ -152,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.0"
+  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?
@@ -28,10 +32,10 @@ module ReactOnRails
       # Next line will throw if the file or manifest does not exist
       hashed_bundle_name = Webpacker.manifest.lookup!(bundle_name)
 
-      # 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.
+      # Support for hashing the server-bundle and having that built
+      # the webpack-dev-server is provided by the config value
+      # "same_bundle_for_client_and_server" where a value of true
+      # would mean that the bundle is created by the webpack-dev-server
       is_server_bundle = bundle_name == ReactOnRails.configuration.server_bundle_js_file
 
       if Webpacker.dev_server.running? && (!is_server_bundle ||

data/lib/tasks/assets.rake

@@ -6,40 +6,60 @@
 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
   # the build command.
   ENV["WEBPACKER_PRECOMPILE"] = "false"
 
+  precompile_tasks = lambda {
+    Rake::Task["react_on_rails:assets:webpack"].invoke
+    puts "Invoking task webpacker:clean from React on Rails"
+
+    # 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)
+  }
+
   if Rake::Task.task_defined?("assets:precompile")
     Rake::Task["assets:precompile"].enhance do
-      Rake::Task["react_on_rails:assets:webpack"].invoke
-      puts "Invoking task webpacker:clean from React on Rails"
-      Rake::Task["webpacker:clean"].invoke
+      precompile_tasks.call
     end
   else
-    Rake::Task.define_task("assets:precompile" => ["react_on_rails:assets:webpack",
-                                                   "webpacker:clean"])
+    Rake::Task.define_task("assets:precompile") do
+      precompile_tasks.call
+    end
   end
 end
 
 # Sprockets independent tasks
+# rubocop:disable Metrics/BlockLength
 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
@@ -55,3 +75,4 @@ namespace :react_on_rails do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/package.json

@@ -1,56 +1,51 @@
 {
   "name": "react-on-rails",
-  "version": "12.0.0",
+  "version": "12.1.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
     "doc": "docs"
   },
   "devDependencies": {
-    "@babel/cli": "^7.0.0",
-    "@babel/core": "^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",
+    "@babel/cli": "^7.12.10",
+    "@babel/core": "^7.12.10",
+    "@babel/plugin-transform-runtime": "^7.12.10",
+    "@babel/plugin-transform-typescript": "^7.12.1",
+    "@babel/preset-env": "^7.12.10",
+    "@babel/preset-react": "^7.12.10",
+    "@babel/types": "^7.12.10",
+    "@types/jest": "^26.0.18",
+    "@types/node": "^14.14.11",
     "@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",
+    "@typescript-eslint/eslint-plugin": "^4.10.0",
+    "@typescript-eslint/parser": "^4.10.0",
     "babelify": "^10.0.0",
     "blue-tape": "^1.0.0",
     "create-react-class": "^15.6.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
+    "eslint": "^7.15.0",
+    "eslint-config-prettier": "^7.0.0",
     "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",
-    "jest": "^25.1.0",
-    "jsdom": "^11.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-prettier": "^3.3.0",
+    "eslint-plugin-react": "^7.21.5",
+    "jest": "^26.6.3",
+    "jsdom": "^16.4.0",
     "nps": "^5.9.3",
-    "prettier": "^2.0.1",
+    "prettier": "^2.2.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",
-    "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"
+    "ts-jest": "^26.4.4",
+    "typescript": "^4.1.2"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.9.6",
+    "@babel/runtime-corejs3": "^7.12.5",
     "concurrently": "^5.1.0"
   },
   "peerDependencies": {

data/rakelib/docker.rake

@@ -6,11 +6,6 @@ namespace :docker do
     sh "docker-compose run lint rake lint:rubocop"
   end
 
-  desc "Run ruby-lint linter from docker"
-  task :ruby do
-    sh "docker-compose run lint rake lint:ruby"
-  end
-
   desc "Run scss-lint linter from docker"
   task :scss do
     sh "docker-compose run lint rake lint:scss"

data/rakelib/examples.rake

@@ -6,7 +6,7 @@
 # Also see example_type.rb
 
 require "yaml"
-require 'rails/version'
+require "rails/version"
 
 require_relative "example_type"
 require_relative "task_helpers"

data/rakelib/lint.rake

@@ -2,18 +2,12 @@
 
 require_relative "task_helpers"
 
-namespace :lint do # rubocop:disable Metrics/BlockLength
+namespace :lint do
   include ReactOnRails::TaskHelpers
 
   desc "Run Rubocop as shell"
   task :rubocop do
-    sh_in_dir(gem_root, "bundle exec rubocop .")
-  end
-
-  desc "Run ruby-lint as shell"
-  task :ruby do
-    puts "See /ruby-lint.yml for what directories are included."
-    sh_in_dir(gem_root, "bundle exec ruby-lint .")
+    sh_in_dir(gem_root, "bundle exec rubocop --version", "bundle exec rubocop .")
   end
 
   desc "Run scss-lint as shell"
@@ -23,10 +17,10 @@ namespace :lint do # rubocop:disable Metrics/BlockLength
 
   desc "Run eslint as shell"
   task :eslint do
-    sh_in_dir(gem_root, "yarn run eslint")
+    sh_in_dir(gem_root, "yarn run eslint --version", "yarn run eslint .")
   end
 
-  desc "Run all eslint & rubocop linters. Skip ruby-lint and scss"
+  desc "Run all eslint & rubocop linters. Skip scss"
   task lint: %i[eslint rubocop] do
     puts "Completed all linting"
   end

data/rakelib/release.rake

@@ -4,6 +4,15 @@ require_relative "task_helpers"
 require_relative File.join(gem_root, "lib", "react_on_rails", "version_syntax_converter")
 require_relative File.join(gem_root, "lib", "react_on_rails", "git_utils")
 require_relative File.join(gem_root, "lib", "react_on_rails", "utils")
+
+class RaisingMessageHandler
+  def add_error(error)
+    raise error
+  end
+end
+
+# rubocop:disable Metrics/BlockLength
+
 desc("Releases both the gem and node package using the given version.
 
 IMPORTANT: the gem version must be in valid rubygem format (no dashes).
@@ -19,19 +28,11 @@ which are installed via `bundle install` and `yarn`
 2nd argument: Perform a dry run by passing 'true' as a second argument.
 
 Example: `rake release[2.1.0,false]`")
-
-# rubocop:disable Metrics/BlockLength
 task :release, %i[gem_version dry_run tools_install] do |_t, args|
   include ReactOnRails::TaskHelpers
 
-  class MessageHandler
-    def add_error(error)
-      raise error
-    end
-  end
-
   # Check if there are uncommited changes
-  ReactOnRails::GitUtils.uncommitted_changes?(MessageHandler.new)
+  ReactOnRails::GitUtils.uncommitted_changes?(RaisingMessageHandler.new)
   args_hash = args.to_hash
 
   is_dry_run = ReactOnRails::Utils.object_to_boolean(args_hash[:dry_run])
@@ -56,19 +57,30 @@ task :release, %i[gem_version dry_run tools_install] do |_t, args|
   # Update dummy app's Gemfile.lock
   bundle_install_in(dummy_app_dir)
 
-  # Stage changes so far
-  sh_in_dir(gem_root, "git add .")
-
   # Will bump the yarn version, commit, tag the commit, push to repo, and release on yarn
-  release_it_command = "$(yarn bin)/release-it".dup
+  release_it_command = +"$(yarn bin)/release-it"
   release_it_command << " #{npm_version}" unless npm_version.strip.empty?
   release_it_command << " --non-interactive --npm.publish"
   release_it_command << " --dry-run --verbose" if is_dry_run
   sh_in_dir(gem_root, release_it_command)
 
   # Release the new gem version
-  unless is_dry_run
-    sh_in_dir(gem_root, "gem release")
-  end
+  sh_in_dir(gem_root, "gem release") unless is_dry_run
+
+  msg = <<~MSG
+    Once you have successfully published, run these commands to update the spec apps:
+
+    cd #{dummy_app_dir}; bundle update react_on_rails
+    cd #{gem_root}#{' '}
+    git commit -a -m 'Update Gemfile.lock for spec app'
+    git push
+  MSG
+  puts msg
 end
 # rubocop:enable Metrics/BlockLength
+
+task :test do
+  unbundled_sh_in_dir(gem_root, "cd #{dummy_app_dir}; bundle update react_on_rails")
+  sh_in_dir(gem_root, "git commit -a -m 'Update Gemfile.lock for spec app'")
+  sh_in_dir(gem_root, "git push")
+end

data/rakelib/run_rspec.rake

@@ -86,16 +86,15 @@ task run_rspec: ["run_rspec:run_rspec"]
 private
 
 def calc_path(dir)
-  path = if dir.is_a?(String)
-           if dir.start_with?(File::SEPARATOR)
-             Pathname.new(dir)
-           else
-             Pathname.new(File.join(gem_root, dir))
-           end
-         else
-           dir
-         end
-  path
+  if dir.is_a?(String)
+    if dir.start_with?(File::SEPARATOR)
+      Pathname.new(dir)
+    else
+      Pathname.new(File.join(gem_root, dir))
+    end
+  else
+    dir
+  end
 end
 
 # Runs rspec in the given directory.
@@ -107,7 +106,7 @@ def run_tests_in(dir, options = {})
 
   command_name = options.fetch(:command_name, path.basename)
   rspec_args = options.fetch(:rspec_args, "")
-  env_vars = "#{options.fetch(:env_vars, '')} TEST_ENV_COMMAND_NAME=\"#{command_name}\"".dup
+  env_vars = +"#{options.fetch(:env_vars, '')} TEST_ENV_COMMAND_NAME=\"#{command_name}\""
   env_vars << "COVERAGE=true" if ENV["USE_COVERALLS"]
   sh_in_dir(path.realpath, "#{env_vars} bundle exec rspec #{rspec_args}")
 end

data/rakelib/task_helpers.rb

@@ -16,14 +16,26 @@ module ReactOnRails
       File.join(gem_root, "spec/dummy")
     end
 
+    # Executes a string or an array of strings in a shell in the given directory in an unbundled environment
+    def sh_in_dir(dir, *shell_commands)
+      shell_commands.flatten.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+    end
+
     # Executes a string or an array of strings in a shell in the given directory
-    def sh_in_dir(dir, shell_commands)
-      shell_commands = [shell_commands] if shell_commands.is_a?(String)
-      shell_commands.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+    def unbundled_sh_in_dir(dir, *shell_commands)
+      Dir.chdir(dir) do
+        # Without `with_unbundled_env`, running bundle in the child directories won't correctly
+        # update the Gemfile.lock
+        Bundler.with_unbundled_env do
+          shell_commands.flatten.each do |shell_command|
+            sh(shell_command.strip)
+          end
+        end
+      end
     end
 
     def bundle_install_in(dir)
-      sh_in_dir(dir, "bundle install")
+      unbundled_sh_in_dir(dir, "bundle install")
     end
 
     def bundle_install_in_no_turbolinks(dir)

data/react_on_rails.gemspec

@@ -32,27 +32,13 @@ Gem::Specification.new do |s|
   s.add_dependency "rainbow", "~> 3.0"
   s.add_dependency "webpacker", ">= 4.0"
 
-  s.add_development_dependency "awesome_print"
   s.add_development_dependency "bundler", "~> 2"
-  s.add_development_dependency "coveralls"
   s.add_development_dependency "gem-release"
-  s.add_development_dependency "generator_spec"
-  s.add_development_dependency "listen"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "pry-byebug"
-  s.add_development_dependency "pry-doc"
-  s.add_development_dependency "pry-rescue"
-  s.add_development_dependency "pry-state"
-  s.add_development_dependency "rails", "~> 5.2"
-
-  s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rubocop", "0.85.0"
-
   s.post_install_message = '
 --------------------------------------------------------------------------------
-Email contact@shakacode.com for access to our slack room and information about our "pro support plan"
-which supports better performance, via caching helpers and our node rendering server.
+Checkout https://www.shakacode.com/react-on-rails-pro for information about
+"React on Rails Pro" which includes one hour a month of support and a gem for
+better performance, via caching helpers, and our node rendering server.
 --------------------------------------------------------------------------------
 '
 end