react_on_rails 11.2.1 → 11.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ddd567b8392bb832697cd980a5267f111d59bfa993bb50b47fc18599f249f5
-  data.tar.gz: d16cc96276768d7739d4271247808dd65a1ce1566fdb44bc1e65283731756be1
+  metadata.gz: b201d34c57c3a7c915b6963a2755a8567ed73e3a41c85b26b77f2a7fcd945f39
+  data.tar.gz: b51be06e2a4dea5918a4685348ad6a42022a899f5be6ad39b2f865bd0bac9a10
 SHA512:
-  metadata.gz: 188e2ec8f54d6019ad2e626cfd2f063485f9d30ab0c1d538e8b9dc43bbd7c9aa58e8c8fb9e4eee9a4d433ac1cbd4b81ad67ba828069b1959ad4176f8c26e0947
-  data.tar.gz: ef4e23b168089ec5e05dd8dd1658fba60e73fbd8f90a38ffa503d1d47bc0831275a52d0e063d262e5e73f10a45c01aac7a4a19f3751bd946841290e89aef4e78
+  metadata.gz: 87902bf57cc4321b38c1c5492945a4a3d8238ce2721e8a5b378cc193e19877ac87ecf9b3ae4f5adf7420d9a861587fd65f5065832d3bfec4af974020309ebcd1
+  data.tar.gz: 21e392e0c4c7da53ecee2bae8023d052c2c015890ae0b38fedd7482cb7c8494c59a7c09bcac6a2ab1d0d0274a6fb23e676cd2ddc1a1bdf8d9d25e45c700e9e73

data/.travis.yml

@@ -4,10 +4,11 @@ language: ruby
 
 rvm:
   # Rails 5 requires 2.2
-  - 2.3.1
-  - 2.4.1
-  - 2.5.0
-  - 2.2.6
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.5.3
+  - 2.2.10
 services:
   - docker
 
@@ -54,13 +55,13 @@ script:
 matrix:
   exclude:
     - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.3.1
+      rvm: 2.3.8
     - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.4.1
+      rvm: 2.4.5
     - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.5.0
+      rvm: 2.5.3
     - gemfile: spec/dummy/Gemfile
-      rvm: 2.2.6
+      rvm: 2.2.10
 
 notifications:
   slack:

data/CHANGELOG.md

@@ -16,7 +16,14 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
-### [11.2.0] - 2018-10-25
+### [11.2.2] - 2018-12-24
+#### Improved
+- rails_context can more easily be called from controller methods. The mandatory param of server_side has been made optional.
+
+### [11.2.1] - 2018-12-06
+## MIGRATION for v11.2
+- If using **React on Rails Pro**, upgrade react_on_rails_pro to a version >= 1.3.
+
 #### Improved
 - To support React v16, updated API for manually calling `ReactOnRails.render(name, props, domNodeId, hydrate)`. Added 3rd @param hydrate Pass truthy to update server rendered html. Default is falsey Any truthy values calls hydrate rather than render. (https://github.com/shakacode/react_on_rails/pull/1159) by [justin808](https://github.com/justin808) and [coopersamuel](https://github.com/coopersamuel).
 
@@ -30,7 +37,10 @@ Changes since last non-beta release.
   
   Thus, developers will need to fix server rendering errors before continuing.
   [PR 1145](https://github.com/shakacode/react_on_rails/pull/1145) by [justin808](https://github.com/justin808).
-  
+
+### 11.2.0 - 2018-12-06
+Do not use. Unpublished. Caused by an issue with the release script.
+
 ### [11.1.8] - 2018-10-14
 
 #### Improved
@@ -854,8 +864,9 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.2.0...master
-[11.2.0]: https://github.com/shakacode/react_on_rails/compare/11.1.8...11.2.0
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.2.2...master
+[11.2.2]: https://github.com/shakacode/react_on_rails/compare/11.2.1...11.2.2
+[11.2.1]: https://github.com/shakacode/react_on_rails/compare/11.1.8...11.2.1
 [11.1.8]: https://github.com/shakacode/react_on_rails/compare/11.1.7...11.1.8
 [11.1.7]: https://github.com/shakacode/react_on_rails/compare/11.1.6...11.1.7
 [11.1.6]: https://github.com/shakacode/react_on_rails/compare/11.1.5...11.1.6

data/CONTRIBUTING.md

@@ -107,7 +107,7 @@ cd spec/dummy
 yarn
 ```
 
-Note, yarn will run the `postinstall` script of `spec/dummy/client` which runs `yarn link` to setup a sym link to the parent package.
+Note, yarn will run the `postinstall` script of `spec/dummy/client` which runs `yarn link` to set up a sym link to the parent package.
 
 #### 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.

data/README.md

@@ -4,7 +4,7 @@
 
 React on Rails integrates Rails with (server rendering of) Facebook's [React](https://github.com/facebook/react) front-end framework.
 
-Intersted in optimizing your webpack setup for React on Rails including code splitting with react-router v4, webpack v4, and react-loadable? [Contact me](mailto:justin@shakacode.com).
+Interested in optimizing your webpack setup for React on Rails including code splitting with react-router v4, webpack v4, and react-loadable? [Contact me](mailto:justin@shakacode.com).
 
 # Intro
 
@@ -36,7 +36,7 @@ React on Rails Pro provides Node server rendering and other performance enhancem
 
 [![2018-09-11_10-31-11](https://user-images.githubusercontent.com/1118459/45467845-5bcc7400-b6bd-11e8-91e1-e0cf806d4ea4.png)](https://blog.shakacode.com/hvmns-90-reduction-in-server-response-time-from-react-on-rails-pro-eb08226687db)
 
-* [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./docs/testimonials/hvmn.md)
+* [HVMN Testimonial, by Paul Benigeri, October 12, 2018](./docs/testimonials/hvmn.md)
 * [HVMN’s 90% Reduction in Server Response Time from React on Rails Pro](https://blog.shakacode.com/hvmns-90-reduction-in-server-response-time-from-react-on-rails-pro-eb08226687db)
 * [Egghead React on Rails Pro Deployment Highlights](https://github.com/shakacode/react_on_rails/wiki/Egghead-React-on-Rails-Pro-Deployment-Highlights)
 
@@ -63,6 +63,10 @@ Please [email me (Justin Gordon), the creator of React on Rails](mailto:justin@s
 
 > 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.
 
+[ResortPass Testimonial, by Leora Juster, December 10, 2018](./docs/testimonials/resortpass.md)
+
+> 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.
+
 From Kyle Maune of Cooper Aerial, May 4, 2018
 
 ![image](https://user-images.githubusercontent.com/1118459/40891236-9b0b406e-671d-11e8-80ee-c026dbd1d5a2.png)
@@ -90,7 +94,7 @@ Note, the best way to understand how to use ReactOnRails is to study a few simpl
 1. Do the quick [tutorial](docs/tutorial.md).
 2. Add React on Rails to an existing Rails app per [the instructions](docs/basics/installation-into-an-existing-rails-app.md).
 3. Look at [spec/dummy](spec/dummy), a simple, no DB example.
-3. Look at [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial); it's a full featured example live at [www.reactrails.com](http://www.reactrails.com).
+3. Look at [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial); it's a full-featured example live at [www.reactrails.com](http://www.reactrails.com).
 
 ## Basic Installation
 
@@ -266,7 +270,7 @@ ReactOnRails will automatically detect a registered generator function. Thus, th
 
 Another reason to use a generator function is that sometimes in server rendering, specifically with React Router, you need to return the result of calling ReactDOMServer.renderToString(element). You can do this by returning an object with the following shape: { renderedHtml, redirectLocation, error }. Make sure you use this function with `react_component_hash`. 
 
-For server rendering, if you wish to return multiple HTML strings from a generator function, you may return an Object from your generator function with a single top level property of `renderedHtml`. Inside this Object, place a key called `componentHtml`, along with any other needed keys. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
+For server rendering, if you wish to return multiple HTML strings from a generator function, you may return an Object from your generator function with a single top-level property of `renderedHtml`. Inside this Object, place a key called `componentHtml`, along with any other needed keys. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
 
 ```js
 { renderedHtml: { componentHtml, customKey1, customKey2} }

data/docs/api/view-helpers-api.md

@@ -93,7 +93,7 @@ end %>
 
 ### rails_context
 
-You can call `rails_context(server_side: true | false)` from your controller or view to see what values are are in the Rails Context. Pass true or false depending on whether you want to see the server side or the client side rails_context.
+You can call `rails_context` or `rails_context(server_side: true|false)` from your controller or view to see what values are are in the Rails Context. Pass true or false depending on whether you want to see the server side or the client side rails_context. Typically, for computing cache keys, you should leave server_side as the default true. When calling this from a controller method, use `helpers.rails_context`.
 
 ------------
 

data/docs/testimonials/resortpass.md

@@ -0,0 +1,13 @@
+# ResortPass Testimonial, by Leora Juster, December 10, 2018
+
+Many can write code that "works." Even fewer can write sophisticated code that both works and reflects a deep understanding of the technologies and paradigms involved. Only a select few can do the aforementioned while assisting in managing the expectations and time constraints of less technically informed members of software product teams to make the best design decisions possible. 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. The code and CSS files are well-organized and contain repeatable patterns easy to understand, allowing my team to build on what has already been accomplished. I learned a great deal from my interactions with Justin and his team, as they are just as great teachers as they are developers, and feel like I get to continually learn from them as I build on top of their code. Their different support and pro plan options make it easy to build a continuous professional relationship despite fluctuations in my team's funding, and their team is always extremely personable, punctual, and professional. 
+
+Leora Juster, Full-Stack Lead Software Developer
+
+[LinkedIn](https://www.linkedin.com/in/leora-juster-38933050)
+
+![image](https://user-images.githubusercontent.com/1118459/50050877-30399b00-00ab-11e9-9e52-2977de45ccae.png)
+
+[ResortPass](https://resortpass.com/)
+
+[![2018-12-15_20-48-35](https://user-images.githubusercontent.com/1118459/50050866-03858380-00ab-11e9-8588-461112f8045b.png)](https://resortpass.com/)

data/docs/testimonials/testimonials.md

@@ -1,8 +1,18 @@
 # Testimonials
-[HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./testimonials/hvmn.md)
+# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./testimonials/hvmn.md)
 
 > 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](./testimonials/hvmn.md).
+
+---
+
+# [Leora from ResortPass](./testimonials/resortpass.md), 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. 
+
+Full writeup [here](./testimonials/resortpass.md).
+
 ---
 
 From Joel Hooks, Co-Founder, Chief Nerd at [egghead.io](https://egghead.io/), January 30, 2017:

data/docs/tutorial.md

@@ -1,6 +1,6 @@
 # React on Rails Basic Tutorial
 
-This tutorial guides you through setting up a new or existing Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering. It is updated to 11.1.4.
+This tutorial guides you through setting up a new or existing Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering. It is updated to 11.2.1.
 
 After finishing this tutorial you will get an application that can do the following (live on Heroku):
 
@@ -60,7 +60,7 @@ bundle exec rails webpacker:install:react
 Add the **React On Rails** gem to your Gemfile:
 
 ```
-gem 'react_on_rails', '11.1.7'         # prefer exact gem version to match npm version
+gem 'react_on_rails', '11.2.1'         # prefer exact gem version to match npm version
 ```
 
 Note: Latest released React On Rails version is considered stable. Please use the latest version to ensure you get all the security patches and the best support.
@@ -101,11 +101,11 @@ Note, foreman defaults to PORT 5000 unless you set the value of PORT in your env
 ## Using a pre-release of rails/webpacker
 Until `rails/webpacker` v4 ships, or if you ever want to try out the master branch, you can modify the React on Rails tutorial instructions slightly. You can see the sequence of commits here. To summarize:
 
-Don't `run rails new with the --webpack=react option`. Instead, add the webpacker gem to the Gemfile such that it points to master, like this if `11.2.0` is the version you want.
+Don't `run rails new with the --webpack=react option`. Instead, add the webpacker gem to the Gemfile such that it points to master, like this if `11.2.1` is the version you want.
 
 ```ruby
 gem 'webpacker', github: "rails/webpacker"
-gem 'react_on_rails', '11.2.0' # always use exact version
+gem 'react_on_rails', '11.2.1' # always use exact version
 ```
 
 Then run these commands:

data/lib/react_on_rails/helper.rb

@@ -277,6 +277,59 @@ module ReactOnRails
       ReactOnRails::JsonOutput.escape(json_value)
     end
 
+    # This is the definitive list of the default values used for the rails_context, which is the
+    # second parameter passed to both component and store generator functions.
+    # This method can be called from views and from the controller, as `helpers.rails_context`
+    #
+    # rubocop:disable Metrics/AbcSize
+    def rails_context(server_side: true)
+      @rails_context ||= begin
+        result = {
+          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?
+        }
+        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
+          # entire URL as UTF-8 already, mostly on the Windows platform (IE11 and lower).
+          original_url_normalized = request.original_url
+          if original_url_normalized.encoding.to_s == "ASCII-8BIT"
+            original_url_normalized = original_url_normalized.force_encoding("ISO-8859-1").encode("UTF-8")
+          end
+
+          # Using Addressable instead of standard URI to better deal with
+          # non-ASCII characters (see https://github.com/shakacode/react_on_rails/pull/405)
+          uri = Addressable::URI.parse(original_url_normalized)
+          # uri = Addressable::URI.parse("http://foo.com:3000/posts?id=30&limit=5#time=1305298413")
+
+          result.merge!(
+            # URL settings
+            href: uri.to_s,
+            location: "#{uri.path}#{uri.query.present? ? "?#{uri.query}" : ''}",
+            scheme: uri.scheme, # http
+            host: uri.host, # foo.com
+            port: uri.port,
+            pathname: uri.path, # /posts
+            search: uri.query, # id=30&limit=5
+            httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"]
+          )
+        end
+        if ReactOnRails.configuration.rendering_extension
+          custom_context = ReactOnRails.configuration.rendering_extension.custom_context(self)
+          result.merge!(custom_context) if custom_context
+        end
+        result
+      end
+
+      @rails_context.merge(serverSide: server_side)
+    end
+    # rubocop:enable Metrics/AbcSize
+
     private
 
     def build_react_component_result_for_server_rendered_string(
@@ -488,58 +541,6 @@ module ReactOnRails
       result
     end
 
-    # This is the definitive list of the default values used for the rails_context, which is the
-    # second parameter passed to both component and store generator functions.
-    # rubocop:disable Metrics/AbcSize
-    def rails_context(server_side: required("server_side"))
-      @rails_context ||= begin
-        result = {
-          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?
-        }
-        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
-          # entire URL as UTF-8 already, mostly on the Windows platform (IE11 and lower).
-          original_url_normalized = request.original_url
-          if original_url_normalized.encoding.to_s == "ASCII-8BIT"
-            original_url_normalized = original_url_normalized.force_encoding("ISO-8859-1").encode("UTF-8")
-          end
-
-          # Using Addressable instead of standard URI to better deal with
-          # non-ASCII characters (see https://github.com/shakacode/react_on_rails/pull/405)
-          uri = Addressable::URI.parse(original_url_normalized)
-          # uri = Addressable::URI.parse("http://foo.com:3000/posts?id=30&limit=5#time=1305298413")
-
-          result.merge!(
-            # URL settings
-            href: uri.to_s,
-            location: "#{uri.path}#{uri.query.present? ? "?#{uri.query}" : ''}",
-            scheme: uri.scheme, # http
-            host: uri.host, # foo.com
-            port: uri.port,
-            pathname: uri.path, # /posts
-            search: uri.query, # id=30&limit=5
-            httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"]
-          )
-        end
-        if ReactOnRails.configuration.rendering_extension
-          custom_context = ReactOnRails.configuration.rendering_extension.custom_context(self)
-          result.merge!(custom_context) if custom_context
-        end
-        result
-      end
-
-      @rails_context.merge(serverSide: server_side)
-    end
-
-    # rubocop:enable Metrics/AbcSize
-
     def replay_console_option(val)
       val.nil? ? ReactOnRails.configuration.replay_console : val
     end

data/lib/react_on_rails/version.rb

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

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "11.2.1",
+  "version": "11.2.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.2.1
+  version: 11.2.2
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2018-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -412,6 +412,7 @@ files:
 - docs/misc/doctrine.md
 - docs/misc/rails3.md
 - docs/testimonials/hvmn.md
+- docs/testimonials/resortpass.md
 - docs/testimonials/testimonials.md
 - docs/tutorial.md
 - lib/generators/USAGE