react_on_rails 8.0.1 → 8.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04272c42e87265c2007505eddd7a236c1eddc7ea
-  data.tar.gz: 2e8fe89b83cfe9a3b3ed65823655008e612b79a1
+  metadata.gz: 8e87c2d5daec14b131563f66b8813aadc20962b0
+  data.tar.gz: d04373277451a8cd984a63e1e325fa520b7c932e
 SHA512:
-  metadata.gz: 853652ede40c5a0f79fc9d81533ae5240a5c5b610334b7f46fe2b973cab2fa371dc296b1387190b9e1a82c48d60510732c2bfaa8719a3f15635a3c7538b2dcac
-  data.tar.gz: 4782f170a4cde2012df509e22ff88a60c22a669901ea5df7afc43af123a459d9c8a87dbe9916f3376abc99a64a515457f18bd152d3fa27113871388374fe9341
+  metadata.gz: 7779155e1479945571bcf199003b158c78422a8f61ae0bde697544132e78e6a48e42617b0662cb664a455b2f305da7badd53286776206b54b55d6eed5fa19f02
+  data.tar.gz: 656b9484ca39ab1b67d26dcaf3e1d38f695c8b8e5be6a1bf8836be392614146eac2c0e8e05576408cee9222d19398372623342f877c4fa026b085a9b7a1cc0ad

data/.rubocop.yml

@@ -3,7 +3,7 @@
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
 
   Include:
     - '**/Rakefile'
@@ -23,12 +23,22 @@ AllCops:
     - 'bin/**/*'
     - !ruby/regexp /old_and_unused\.rb$/
     - 'spec/react_on_rails/dummy-for-generators/**/*'
+    - 'spec/dummy/Procfile.*'
     - 'spec/dummy/bin/**/*'
     - 'spec/dummy/client/node_modules/**/*'
     - 'spec/dummy/client/node_modules/**/.*'
     - 'gen-examples/examples/**/.*'
     - 'gen-examples/examples/**/*'
 
+Style/FileName:
+  Exclude:
+    - 'Gemfile'
+    - 'spec/dummy/Gemfile'
+
+# Turn off until we require 2.3 ruby
+Style/SafeNavigation:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 120
 

data/.travis.yml

@@ -3,12 +3,9 @@ sudo: required
 language: ruby
 
 rvm:
-  # Ruby 2.0.0 fails due to newer Nokogir
-  # nokogiri-1.7.0.1 requires ruby version >= 2.1.0, which is incompatible with the current version, ruby 2.0.0p648
   # Rails 5 requires 2.2
-  # - 2.1.10
-  - 2.2.6
   - 2.3.1
+  - 2.4.1
 services:
   - docker
 
@@ -36,20 +33,21 @@ before_install:
   - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16"
 
 install:
-  - travis_retry nvm install node
+  - travis_retry gem install bundler
+  - travis_retry nvm install node 8.0.0
   - node -v
-  - travis_retry npm i -g yarn@0.20.3
-  - travis_retry yarn
+  - travis_retry npm i -g yarn@0.24.6
+  - travis_retry yarn global add babel-cli
   - travis_retry bundle install
-  - rake dummy_apps
-  - rake examples
-  - rake node_package
+  - travis_retry yarn
+  - travis_retry yarn run build
+  - bundle exec rake prepare_for_ci
 
 before_script:
   - "export DISPLAY=:99"
 
 script:
-  - rake
+  - bundle exec rake
 
 notifications:
   slack:

data/CHANGELOG.md

@@ -8,6 +8,16 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests.*
 
+## [8.0.2]
+### Fixed
+- Any failure in webpack to build test files quits tests. 
+- CI Improvements: 
+  - Switched to yarn link and removed relative path install of react-on-rails
+  - Removed testing of Turbolinks 2
+  - All tests run against Rails 5.1.1
+  - Fixed test failures against Ruby 2.4
+- [#862](https://github.com/shakacode/react_on_rails/pull/862) by [justin808](https://github.com/justin808)
+
 ## [8.0.1]
 ### Fixed
 - Generator no longer modifies `assets.rb`. [#859](https://github.com/shakacode/react_on_rails/pull/859) by [justin808](https://github.com/justin808)
@@ -596,7 +606,9 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/8.0.0...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/8.0.2...master
+[8.0.2]: https://github.com/shakacode/react_on_rails/compare/8.0.1...8.0.2
+[8.0.1]: https://github.com/shakacode/react_on_rails/compare/8.0.0...8.0.1
 [8.0.0]: https://github.com/shakacode/react_on_rails/compare/7.0.4...8.0.0
 [8.0.0-beta.3]: https://github.com/shakacode/react_on_rails/compare/8.0.0-beta.2...8.0.0-beta.3
 [8.0.0-beta.2]: https://github.com/shakacode/react_on_rails/compare/8.0.0-beta.1...8.0.0-beta.2

data/CONTRIBUTING.md

@@ -111,7 +111,7 @@ When you use a relative path, be sure to run the above `yarn` command whenever y
 
 #### Example: Testing NPM changes with the dummy app
 1. Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails/blob/master/node_package/src/clientStartup.js#L181) in `react_on_rails/node_package/src/clientStartup.js` to confirm we're getting an update to the node package.
-2. Run the install script `npm run install-react-on-rails` in `react_on_rails/spec/dummy` to copy over our changes to the dummy app. Alternatively, you can run `rm -rf node_modules/react-on-rails && npm i 'file:../../../'` in `react_on_rails/spec/dummy/client`. Our NPM changes are now available in the dummy app.
+2. The "postinstall" script of "spec/dummy/client" calls "yarn link react-on-rails" to setup a sym link to the parent package.
 3. Refresh the browser if the server is already running or start the server using `foreman start` from `react_on_rails/spec/dummy` and navigate to `http://localhost:5000/`. You will now see the `Hello!` message printed in the browser's console.
 
 _Note: running `npm i` automatically builds the npm package before installing. However, when using yarn you will need to run `yarn run build` in the root directory before the install script. This will be updated when [yarn issue #2649](https://github.com/yarnpkg/yarn/issues/2649) (above) is resolved._
@@ -215,7 +215,7 @@ If you run `rspec` at the top level, you'll see this message: `require': cannot
 
 After running a test, you can view the coverage results SimpleCov reports by opening `coverage/index.html`.
 
-To test `spec/dummy` against Turbolinks 2, install the gem by running `ENABLE_TURBOLINKS_2=TRUE bundle install` in the `spec/dummy` directory before running `rake`. Turbolinks 5 is the default.
+Turbolinks 5 is included in the test app, unless "DISABLE_TURBOLINKS" is set to YES in the environment.
 
 Run `rake -T` or `rake -D` to see testing options.
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem"s dependencies in react_on_rails.gemspec
@@ -14,20 +16,16 @@ gem "mini_racer"
 gem "puma"
 gem "rails", "5.1.1"
 gem "rails_12factor"
-gem "rubocop", "0.47.1", require: false
+gem "rubocop", require: false
 gem "ruby-lint", require: false
 gem "sass-rails", "~> 5.0"
 gem "scss_lint", require: false
-gem "sdoc", "~> 0.4.0", group: :doc
+gem "sdoc", group: :doc
 gem "spring"
 gem "sqlite3"
-if ENV["ENABLE_TURBOLINKS_2"].nil? || ENV["ENABLE_TURBOLINKS_2"].strip.empty?
-  gem "turbolinks", "~> 5.0"
-else
-  gem "turbolinks", "2.5.3"
-end
-gem "uglifier", ">= 2.7.2"
-gem "web-console", "~> 2.0", group: :development
+gem "turbolinks", "~> 5.0"
+gem "uglifier"
+gem "web-console", group: :development
 
 # below are copied from spec/dummy/Gemfile
 gem "capybara"
@@ -42,12 +40,4 @@ gem "poltergeist"
 gem "selenium-webdriver"
 gem "webpacker_lite"
 
-################################################################################
-# Favorite debugging gems
-gem "pry"
-gem "pry-byebug"
-gem "pry-doc"
-gem "pry-rails"
-gem "pry-rescue"
-gem "pry-stack_explorer"
-################################################################################
+gem "rainbow"

data/README.md

@@ -1,9 +1,9 @@
 [![Build Status](https://travis-ci.org/shakacode/react_on_rails.svg?branch=master)](https://travis-ci.org/shakacode/react_on_rails) [![Codeship Status for shakacode/react_on_rails](https://app.codeship.com/projects/cec6c040-971f-0134-488f-0a5146246bd8/status?branch=master)](https://app.codeship.com/projects/187011) [![Dependency Status](https://gemnasium.com/shakacode/react_on_rails.svg)](https://gemnasium.com/shakacode/react_on_rails) [![Gem Version](https://badge.fury.io/rb/react_on_rails.svg)](https://badge.fury.io/rb/react_on_rails) [![npm version](https://badge.fury.io/js/react-on-rails.svg)](https://badge.fury.io/js/react-on-rails) [![Code Climate](https://codeclimate.com/github/shakacode/react_on_rails/badges/gpa.svg)](https://codeclimate.com/github/shakacode/react_on_rails) [![Coverage Status](https://coveralls.io/repos/shakacode/react_on_rails/badge.svg?branch=master&service=github)](https://coveralls.io/github/shakacode/react_on_rails?branch=master)
 
-The Docs here on `master` refer to 8.0.0 including support for [webpacker_lite](https://github.com/shakacode/webpacker_lite)! [7.0.4 docs](https://github.com/shakacode/react_on_rails/tree/7.0.4).
+The Docs here on `master` refer to 8.0.0 including support for [webpacker_lite](https://github.com/shakacode/webpacker_lite)!
+*Use the [7.0.4 docs](https://github.com/shakacode/react_on_rails/tree/7.0.4) to refer to the older asset pipeline way.*
 
-**[VERSION 8.0.0](https://rubygems.org/gems/react_on_rails/versions/8.0.0.beta.3)** has shipped with [webpacker_lite](https://github.com/shakacode/webpacker_lite) support! [react-webpack-rails-tutorial PR #395](https://github.com/shakacode/react-webpack-rails-tutorial/pull/395) shows the changes needed to go to Webpacker Lite.
-* Why did we fork webpacker to make webpacker_lite? Please provide feedback on my draft article: [Webpacker Lite: Why Did  We Fork Webpacker?](https://medium.com/@railsonmaui/webpacker-lite-why-did-we-fork-webpacker-ee3305688d66) (Draft will soon become regular article).
+**[VERSION 8.0.0](https://rubygems.org/gems/react_on_rails/versions/8.0.0.beta.3)** has shipped with [webpacker_lite](https://github.com/shakacode/webpacker_lite) support! [react-webpack-rails-tutorial PR #395](https://github.com/shakacode/react-webpack-rails-tutorial/pull/395) shows the changes needed to migrate from the Asset Pipeline to Webpacker Lite. For more information, see my article: [Webpacker Lite: Why Fork Webpacker?](https://blog.shakacode.com/webpacker-lite-why-fork-webpacker-f0a7707fac92). Per recent discussions, we may [eventually merge Webpacker Lite changes back into Webpacker](https://github.com/rails/webpacker/issues/464). If so, any changes will be minor if you're using Webpacker Lite.
 
 **For a complete example of this gem, see our live demo at [www.reactrails.com](http://www.reactrails.com). ([Source Code](https://github.com/shakacode/react-webpack-rails-tutorial))**
 
@@ -38,6 +38,7 @@ For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](./KUDOS.md).
 
 ### Articles
 
+* [Webpacker Lite: Why Fork Webpacker?](https://blog.shakacode.com/webpacker-lite-why-fork-webpacker-f0a7707fac92)
 * [React on Rails, 2000+ 🌟 Stars](https://medium.com/shakacode/react-on-rails-2000-stars-32ff5cfacfbf#.6gmfb2gpy)
 * [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724)
 
@@ -512,6 +513,9 @@ Node.js can be used as the backend for server-side rendering instead of [execJS]
 
 ## Additional Documentation
 **Try out our new [Documentation Gitbook](https://shakacode.gitbooks.io/react-on-rails/content/) for improved readability & reference!**
++ **Webpacker Lite**
+  + [Webpacker Lite: Why Fork Webpacker?](https://blog.shakacode.com/webpacker-lite-why-fork-webpacker-f0a7707fac92)
+
 + **Rails**
   + [Rails Assets](./docs/additional-reading/rails-assets.md)
   + [Rails Engine Integration](./docs/additional-reading/rails-engine-integration.md)

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Rake will automatically load any *.rake files inside of the "rakelib" folder
 # See rakelib/
-tasks = %w(run_rspec lint)
+tasks = %w[run_rspec lint]
 if ENV["USE_COVERALLS"] == "TRUE"
   require "coveralls/rake/task"
   Coveralls::RakeTask.new
@@ -12,3 +14,6 @@ task default: tasks
 
 desc "All actions but no examples, good for local developer run."
 task all_but_examples: ["run_rspec:all_but_examples", "lint"]
+
+desc "Prepare for ci, including node_package, dummy app, and generator examples"
+task prepare_for_ci: %w[node_package dummy_apps examples]

data/app/helpers/react_on_rails_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/ModuleLength
 # NOTE:
 # For any heredoc JS:
@@ -11,7 +13,7 @@ require "react_on_rails/json_output"
 module ReactOnRailsHelper
   include ReactOnRails::Utils::Required
 
-  COMPONENT_HTML_KEY = "componentHtml".freeze
+  COMPONENT_HTML_KEY = "componentHtml"
 
   # The env_javascript_include_tag and env_stylesheet_link_tag support the usage of a webpack
   # dev server for providing the JS and CSS assets during development mode. See
@@ -175,7 +177,7 @@ module ReactOnRailsHelper
   # that contains a data props.
   def redux_store_hydration_data
     return if @registered_stores_defer_render.blank?
-    @registered_stores_defer_render.reduce("") do |accum, redux_store_data|
+    @registered_stores_defer_render.reduce("".dup) do |accum, redux_store_data|
       accum << render_redux_store_data(redux_store_data)
     end.html_safe
   end
@@ -188,32 +190,32 @@ module ReactOnRailsHelper
   # If you have more than one line that needs to be executed, wrap it in an IIFE.
   # JS exceptions are caught and console messages are handled properly.
   def server_render_js(js_expression, options = {})
-    wrapper_js = <<-JS
-(function() {
-  var htmlResult = '';
-  var consoleReplayScript = '';
-  var hasErrors = false;
-
-  try {
-    htmlResult =
+    wrapper_js = <<-JS.strip_heredoc
       (function() {
-        return #{js_expression};
-      })();
-  } catch(e) {
-    htmlResult = ReactOnRails.handleError({e: e, name: null,
-      jsCode: '#{escape_javascript(js_expression)}', serverSide: true});
-    hasErrors = true;
-  }
-
-  consoleReplayScript = ReactOnRails.buildConsoleReplay();
-
-  return JSON.stringify({
-      html: htmlResult,
-      consoleReplayScript: consoleReplayScript,
-      hasErrors: hasErrors
-  });
-
-})()
+        var htmlResult = '';
+        var consoleReplayScript = '';
+        var hasErrors = false;
+
+        try {
+          htmlResult =
+            (function() {
+              return #{js_expression};
+            })();
+        } catch(e) {
+          htmlResult = ReactOnRails.handleError({e: e, name: null,
+            jsCode: '#{escape_javascript(js_expression)}', serverSide: true});
+          hasErrors = true;
+        }
+
+        consoleReplayScript = ReactOnRails.buildConsoleReplay();
+
+        return JSON.stringify({
+            html: htmlResult,
+            consoleReplayScript: consoleReplayScript,
+            hasErrors: hasErrors
+        });
+
+      })()
     JS
 
     result = ReactOnRails::ServerRenderingPool.server_render_js_with_console_logging(wrapper_js)
@@ -300,11 +302,13 @@ module ReactOnRailsHelper
 
   def compose_react_component_html_with_spec_and_console(component_specification_tag, rendered_output, console_script)
     # IMPORTANT: Ensure that we mark string as html_safe to avoid escaping.
+    # rubocop:disable Layout/IndentHeredoc
     <<-HTML.html_safe
 #{component_specification_tag}
     #{rendered_output}
     #{console_script}
     HTML
+    # rubocop:enable Layout/IndentHeredoc
   end
 
   # prepend the rails_context if not yet applied
@@ -367,6 +371,7 @@ module ReactOnRailsHelper
     #
     # Read more here: http://timelessrepo.com/json-isnt-a-javascript-subset
 
+    # rubocop:disable Layout/IndentHeredoc
     wrapper_js = <<-JS
 (function() {
   var railsContext = #{rails_context(server_side: true).to_json};
@@ -381,6 +386,7 @@ module ReactOnRailsHelper
   });
 })()
     JS
+    # rubocop:enable Layout/IndentHeredoc
 
     result = ReactOnRails::ServerRenderingPool.server_render_js_with_console_logging(wrapper_js)
 
@@ -407,22 +413,22 @@ module ReactOnRailsHelper
 
   def initialize_redux_stores
     return "" unless @registered_stores.present? || @registered_stores_defer_render.present?
-    declarations = "var reduxProps, store, storeGenerator;\n"
+    declarations = "var reduxProps, store, storeGenerator;\n".dup
 
     all_stores = (@registered_stores || []) + (@registered_stores_defer_render || [])
 
-    result = <<-JS
+    result = <<-JS.dup
       ReactOnRails.clearHydratedStores();
     JS
 
     result << all_stores.each_with_object(declarations) do |redux_store_data, memo|
       store_name = redux_store_data[:store_name]
       props = props_string(redux_store_data[:props])
-      memo << <<-JS
-reduxProps = #{props};
-storeGenerator = ReactOnRails.getStoreGenerator('#{store_name}');
-store = storeGenerator(reduxProps, railsContext);
-ReactOnRails.setStore('#{store_name}', store);
+      memo << <<-JS.strip_heredoc
+        reduxProps = #{props};
+        storeGenerator = ReactOnRails.getStoreGenerator('#{store_name}');
+        store = storeGenerator(reduxProps, railsContext);
+        ReactOnRails.setStore('#{store_name}', store);
       JS
     end
     result
@@ -486,7 +492,7 @@ ReactOnRails.setStore('#{store_name}', store);
   def send_tag_method(tag_method_name, args)
     asset_type = use_hot_reloading? ? :hot : :static
     assets = Array(args[asset_type])
-    options = args.delete_if { |key, _value| %i(hot static).include?(key) }
+    options = args.delete_if { |key, _value| %i[hot static].include?(key) }
     send(tag_method_name, *assets, options) unless assets.empty?
   end
 

data/docs/basics/generator.md

@@ -41,7 +41,7 @@ can pass the redux option if you'd like to have redux setup for you automaticall
 
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators"
 require_relative "generator_messages"
 require_relative "generator_helper"
@@ -38,26 +40,26 @@ module ReactOnRails
       end
 
       def create_react_directories
-        dirs = %w(components containers startup)
+        dirs = %w[components containers startup]
         dirs.each { |name| empty_directory("client/app/bundles/HelloWorld/#{name}") }
       end
 
       def copy_base_files
         base_path = "base/base/"
-        base_files = %w(app/controllers/hello_world_controller.rb
+        base_files = %w[app/controllers/hello_world_controller.rb
                         config/webpacker_lite.yml
                         client/.babelrc
                         client/webpack.config.js
-                        client/REACT_ON_RAILS_CLIENT_README.md)
+                        client/REACT_ON_RAILS_CLIENT_README.md]
         base_files.each { |file| copy_file("#{base_path}#{file}", file) }
       end
 
       def template_base_files
         base_path = "base/base/"
-        %w(app/views/layouts/hello_world.html.erb
+        %w[app/views/layouts/hello_world.html.erb
            config/initializers/react_on_rails.rb
            Procfile.dev
-           client/package.json).each { |file| template("#{base_path}#{file}.tt", file) }
+           client/package.json].each { |file| template("#{base_path}#{file}.tt", file) }
       end
 
       def template_package_json
@@ -136,12 +138,12 @@ STRING
           regexp = / {2}"scripts": {/
         else
           regexp = /^{/
-          replacement = <<-STRING
-{
-  "scripts": {
-    #{postinstall}
-  },
-STRING
+          replacement = <<-STRING.strip_heredoc
+            {
+              "scripts": {
+                #{postinstall}
+              },
+          STRING
         end
 
         contents.gsub!(regexp, replacement)

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require "rails/generators"
 require_relative "generator_helper"
 
 module ReactOnRails
   module Generators
-    FALLBACK_OPTION_FOR_NODE_MODULES = <<-TEXT.freeze
+    FALLBACK_OPTION_FOR_NODE_MODULES = <<-TEXT
     // This fixes an issue with resolving 'react' when using a local symlinked version
     // of the node_package folder
     modules: [
@@ -26,29 +28,20 @@ module ReactOnRails
                    desc: "Setup prerender true for server rendered examples"
 
       def copy_rspec_files
-        %w(spec/spec_helper.rb
+        %w[spec/spec_helper.rb
            spec/rails_helper.rb
            spec/simplecov_helper.rb
-           .rspec).each { |file| copy_file(file) }
+           .rspec].each { |file| copy_file(file) }
       end
 
       def copy_tests
-        %w(spec/features/hello_world_spec.rb).each { |file| copy_file(file) }
-      end
-
-      # We want to use the node module in the local build, not the one published to NPM
-      def change_package_json_to_use_local_react_on_rails_module
-        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": "file:../../../..",')
-        File.open(package_json, "w+") { |f| f.puts new_contents }
+        %w[spec/features/hello_world_spec.rb].each { |file| copy_file(file) }
       end
 
       def add_test_related_gems_to_gemfile
         gem("rspec-rails", group: :test)
+        gem("poltergeist", group: :test)
         gem("coveralls", require: false)
-        gem("poltergeist")
       end
 
       def replace_prerender_if_server_rendering
@@ -66,8 +59,7 @@ module ReactOnRails
         contents = File.read(client_package_json)
         replacement_value = <<-STRING
   "scripts": {
-    "postinstall": "yarn run install-react-on-rails",
-    "install-react-on-rails": "rm -rf node_modules/react-on-rails && npm i 'file:../../../..'",
+    "postinstall": "yarn link react-on-rails",
 STRING
         new_client_package_json_contents = contents.gsub(/ {2}"scripts": {/,
                                                          replacement_value)