react_on_rails 11.1.1 → 11.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88646d6eaec039bf8e03a91804ee7062c2b95f69ee644afeacbcccbbbd00f8e0
-  data.tar.gz: 06d46a292591e413c2167f2c1be950edd07a5da2c26165983df7334038b6e180
+  metadata.gz: 24362cafd62e7bf03e57b82b3fad400765ab55dda2eba19c68411f5b6599bbbe
+  data.tar.gz: '091f3c971b243209fb72c53723f72f2c9915533f20602b0b7d94297a1e0ffd96'
 SHA512:
-  metadata.gz: a27e34d57bb71ec8143876947fa4df1a11a997d3f48bbe66837153efe54dd430f9e8cdd1bda24478064e4374f881478eef1de53e960a45aa66693c00f6dd1fa0
-  data.tar.gz: 222bcabda201fd61f367fa6f26e6c7c4efb05bedfb3017df31f7913ebea654e41ee60d64c53707dd3b0b5d7ddc983083913f4df531e9034603e6283ed41fd493
+  metadata.gz: eccf5d97a8c77b782082d94646e5068dcf7f4f667f0efdc23bc459c5ff7b78d95750162f96bc398691825860ea8b9fe8c1f2e59cc0418a5e46d9e176ab387c91
+  data.tar.gz: 10bb36f5b233e5444b92a900c7e16b8b6a70b6c6a4d5d925aaa139c411ab526797d64b0ea334dc5c096143698087c3fe3699dd90b85f367b16aa6a62742f9870

data/.rubocop.yml

@@ -8,6 +8,8 @@ AllCops:
   Include:
     - '**/Rakefile'
     - '**/config.ru'
+    - 'Gemfile'
+    - '**/*.rb'
 
   Exclude:
     - 'vendor/**/*'

data/CHANGELOG.md

@@ -9,6 +9,16 @@ See [Upgrading React on Rails](./docs/basics/upgrading-react-on-rails.md) for mo
 Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
+
+### [11.1.2] - 2018-08-18
+
+#### Fixed
+- Tests now properly exit if the config.build_test_command fails!
+- Source path for project using Webpacker would default to "app/javascript" even if when the node_modules 
+  directory was set to "client". Fix now makes the configuration of this crystal clear.
+- renamed method RenderOptions.has_random_dom_id? to RenderOptions.random_dom_id? for rubocop rule.
+[PR 1133](https://github.com/shakacode/react_on_rails/pull/1133) by [justin808](https://github.com/justin808)
+
 ### [11.1.1] - 2018-08-09
 #### Fixed
 - `TRUE` was deprecated in ruby 2.4, using `true` instead. [PR 1128](https://github.com/shakacode/react_on_rails/pull/1128) by [Aguardientico](https://github.com/Aguardientico).

data/README.md

@@ -27,9 +27,10 @@ Given that rails/webpacker gem already provides basic React integration, why wou
 
 See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
 
-
 ## React on Rails Pro and ShakaCode Pro Support
 
+![image](https://user-images.githubusercontent.com/1118459/44008223-9b29d1b8-9e3c-11e8-90a8-9d38dc241ef9.png)
+
 React on Rails Pro provides Node server rendering and other performance enhancements for React on Rails. It's live at [egghead.io](https://egghead.io). See the [React on Rails Pro Docs](https://github.com/shakacode/react_on_rails/wiki).
 
 The [React on Rails Pro Support Plan](http://www.shakacode.com/work/shakacode-pro-support.pdf) can help you with:
@@ -44,7 +45,6 @@ ShakaCode can also help you with your Rails, JavaScript, and React-Native develo
 
 The article [Why Hire ShakaCode?](https://blog.shakacode.com/can-shakacode-help-you-4a5b1e5a8a63#.jex6tg9w9) provides additional details about our projects.
 
-  
 Please [email me (Justin Gordon), the creator of React on Rails](mailto:justin@shakacode.com), to see if I can help you or if you want an invite to our private Slack room for ShakaCode.
 
 ## Testimonials for Hiring ShakaCode and our "Pro Support"

data/docs/basics/configuration.md

@@ -1,5 +1,40 @@
 Here is the full set of config options. This file is `/config/initializers/react_on_rails.rb`
 
+First, you should have a `/config/webpacker.yml` setup.
+
+Here is the setup when using the recommended `/client` directory for your node_modules and source files:
+
+```yaml
+# Note: Base output directory of /public is assumed for static files
+default: &default
+  compile: false
+  # Used in your webpack configuration. Must be created in the
+  # public_output_path folder
+  manifest: manifest.json
+  cache_manifest: false
+  source_path: client/app
+
+development:
+  <<: *default
+  # generated files for development, in /public/webpack/dev
+  public_output_path: webpack/dev
+
+test:
+  <<: *default
+  # generated files for tests, in /public/webpack/test
+  public_output_path: webpack/test
+
+production:
+  <<: *default
+  # generated files for tests, in /public/webpack/production
+  public_output_path: webpack/production
+  cache_manifest: true
+```
+
+Here's a representative `/config/initializers/react_on_rails.rb` setup when using this `/client` directory
+for all client files, including your sources and node_modules.
+
+
 ```ruby
 # frozen_string_literal: true
 
@@ -24,7 +59,7 @@ ReactOnRails.configure do |config|
 
   # defaults to "" (top level)
   #
-  config.node_modules_location = ""
+  config.node_modules_location = "client" # Recommended!
 
   # This configures the script to run to build the production assets by webpack. Set this to nil
   # if you don't want react_on_rails building this file for you.
@@ -52,17 +87,18 @@ ReactOnRails.configure do |config|
   #   public_output_path: packs-test
   # which means files in /public/packs-test
   #
-  # Alternately, you may configure this. It is relative to your Rails root directory.
-  # A custom, non-webpacker, config might use something like:
+  # Alternately, you may configure this if you are NOT using webpacker. It is relative to your Rails 
+  # root directory. A custom, non-webpacker, config might use something like:
   #
   # config.generated_assets_dir = File.join(%w[public webpack], Rails.env)
   # This setting should not be used if using webpacker. 
 
+  # CONFIGURE YOUR SOURCE FILES 
   # The test helper needs to know where your JavaScript files exist. The default is configured
   # by your config/webpacker.yml soure_path:
-  # source_path: app/javascript
+  # source_path: client/app/javascript # if using recommended /client directory
   #
-  # If you have a non-default `node_modules_location`, that is assumed to be the location of your source
+  # If you are not using webpacker, the `node_modules_location` is assumed to be the location of your source
   # files.
 
   # Define the files we need to check for webpack compilation when running tests.

data/docs/basics/generator-functions-and-railscontext.md

@@ -43,11 +43,18 @@ Note: you never make these calls. React on Rails makes these calls when it does
 
 (Note: see below [section](#multiple-react-components-on-a-page-with-one-store) on how to setup redux stores that allow multiple components to talk to the same store.)
 
-The `railsContext` has: (see implementation in file [react_on_rails_helper.rb](https://github.com/shakacode/react_on_rails/tree/master/app/helpers/react_on_rails_helper.rb), method `rails_context` for the definitive list).
+The `railsContext` has: (see implementation in file [ReactOnRails::Helper](https://github.com/shakacode/react_on_rails/tree/master/lib/react_on_rails/helper.rb), method `rails_context` for the definitive list).
 
 ```ruby
   {
     railsEnv: Rails.env
+    inMailer: in_mailer?,
+    # Locale settings
+    i18nLocale: I18n.locale,
+    i18nDefaultLocale: I18n.default_locale,
+    rorVersion: ReactOnRails::VERSION,
+    rorPro: ReactOnRails::Utils.react_on_rails_pro?
+    
     # URL settings
     href: request.original_url,
     location: "#{uri.path}#{uri.query.present? ? "?#{uri.query}": ""}",
@@ -56,6 +63,7 @@ The `railsContext` has: (see implementation in file [react_on_rails_helper.rb](h
     port: uri.port,
     pathname: uri.path, # /posts
     search: uri.query, # id=30&limit=5
+    httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"]
 
     # Other
     serverSide: boolean # Are we being called on the server or client? Note: if you conditionally
@@ -64,6 +72,8 @@ The `railsContext` has: (see implementation in file [react_on_rails_helper.rb](h
   }
 ```
 
+Plus, you can add your customizations to this. See "rendering extension" below.
+
 ## Rails Context
 
 The `railsContext` is a second param passed to your generator functions for React components. This is in addition to the props that are passed from the `react_component` Rails helper. For example:

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -50,7 +50,7 @@ module ReactOnRails
         replacement_value = <<-STRING
   "scripts": {
     "postinstall": "yarn link react-on-rails",
-STRING
+        STRING
         new_client_package_json_contents = contents.gsub(/ {2}"scripts": {/,
                                                          replacement_value)
         File.open(package_json, "w+") { |f| f.puts new_client_package_json_contents }

data/lib/react_on_rails/configuration.rb

@@ -116,7 +116,7 @@ module ReactOnRails
       webpacker_public_output_path = ReactOnRails::WebpackerUtils.webpacker_public_output_path
 
       if File.expand_path(generated_assets_dir) == webpacker_public_output_path.to_s
-        Rails.logger.warn("You specified /config/initializers/react_on_rails.rb generated_assets_dir "\
+        Rails.logger.warn("You specified generated_assets_dir in `config/initializers/react_on_rails.rb` "\
         "with Webpacker. Remove this line from your configuration file.")
       else
         msg = <<-MSG.strip_heredoc

data/lib/react_on_rails/react_component/render_options.rb

@@ -36,7 +36,7 @@ module ReactOnRails
         end
       end
 
-      def has_random_dom_id?
+      def random_dom_id?
         return false if options[:id]
 
         return false unless random_dom_id
@@ -77,7 +77,7 @@ module ReactOnRails
       attr_reader :options
 
       def base_dom_id
-       "#{react_component_name}-react-component"
+        "#{react_component_name}-react-component"
       end
 
       def generate_unique_dom_id

data/lib/react_on_rails/test_helper.rb

@@ -75,6 +75,16 @@ module ReactOnRails
             "outdated/missing bundles based on source_path #{source_path}"
           puts
           @printed_once = true
+
+          if ReactOnRails::WebpackerUtils.using_webpacker? &&
+             ReactOnRails::Utils.using_webpacker_source_path_is_not_defined_and_custom_node_modules?
+            msg = <<-MSG.strip_heredoc
+              WARNING: Define config.webpacker.yml to include sourcePath to configure
+              the location of your JavaScript source for React on Rails.
+              Default location of #{source_path} is used.
+            MSG
+            puts ReactOnRails::Utils.wrap_message(msg, :orange)
+          end
         end
       end
 

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"
+    TRUNCATION_FILLER = "\n... TRUNCATED ...\n".freeze
 
     # 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
@@ -57,7 +57,9 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
         MSG
         # rubocop:enable Layout/IndentHeredoc
         puts wrap_message(msg)
-        exit(1)
+
+        # Rspec catches exit without! in the exit callbacks
+        exit!(1)
       end
       [stdout, stderr, status]
     end
@@ -135,6 +137,13 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
       end
     end
 
+    def self.using_webpacker_source_path_is_not_defined_and_custom_node_modules?
+      return false unless ReactOnRails::WebpackerUtils.using_webpacker?
+
+      !ReactOnRails::WebpackerUtils.webpacker_source_path_explicit? &&
+        ReactOnRails.configuration.node_modules_location.present?
+    end
+
     def self.generated_assets_full_path
       if ReactOnRails::WebpackerUtils.using_webpacker?
         ReactOnRails::WebpackerUtils.webpacker_public_output_path
@@ -163,10 +172,10 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
 
       return str[0, 1] + TRUNCATION_FILLER if max_length == 1
 
-      midpoint = (str.length / 2.0).ceil;
-      to_remove = str.length - max_length;
-      lstrip = (to_remove / 2.0).ceil;
-      rstrip = to_remove - lstrip;
+      midpoint = (str.length / 2.0).ceil
+      to_remove = str.length - max_length
+      lstrip = (to_remove / 2.0).ceil
+      rstrip = to_remove - lstrip
       str[0..(midpoint - lstrip - 1)] + TRUNCATION_FILLER + str[(midpoint + rstrip)..-1]
     end
   end

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "11.1.1".freeze
+  VERSION = "11.1.2".freeze
 end

data/lib/react_on_rails/webpacker_utils.rb

@@ -31,6 +31,12 @@ module ReactOnRails
       Webpacker.config.public_manifest_path.exist?
     end
 
+    def self.webpacker_source_path_explicit?
+      # WARNING: Calling private method `data` on Webpacker::Configuration, lib/webpacker/configuration.rb
+      config_webpacker_yml = Webpacker.config.send(:data)
+      config_webpacker_yml[:source_path].present?
+    end
+
     def self.check_manifest_not_cached
       return unless using_webpacker? && Webpacker.config.cache_manifest?
       msg = <<-MSG.strip_heredoc

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "11.1.1",
+  "version": "11.1.2",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 11.1.1
+  version: 11.1.2
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable