render_async 2.1.8 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25aa48ca09d482b0cdf14569d09e594ef525deaba38b9be8c39bc200b86de28e
-  data.tar.gz: 3d52e3a5a9fcba834c502aa78ea429cfa650eea45de4e27654294e560cc9c177
+  metadata.gz: 6efd10ad97f50cae5b58a0ff6042df5c0b9f5ed0b27ca1a498f4cdb84172ab79
+  data.tar.gz: 8daab586cb6b11d66bc873e12929ee2bb1162a6b5578e343ddeb6f03c1094c71
 SHA512:
-  metadata.gz: 0b50f5bd6a991c2af51ba3fc52b64dc0eda858e8827ef29b57dd4b8e1d1fd17134ddec8aeeb0df1e337666c9fb909f7b0664a85a069a3f3974fafa99273e66f9
-  data.tar.gz: 06adc494ef7f021ed5211f48f9103cabd5a3ebd42475cbcaedb7ac026df9cc0e62981e465b330ca17e351a17c53322e09bf51d055c2aaa64155457452820aa7f
+  metadata.gz: aaa98a754f9cbce70521702793d6307fbb976b064a9b981a7a5c43db5dd12527cfa81f5a07269476958f12ae0f0f2a79a4038236146cda6a2bfc2e23b3c36fbf
+  data.tar.gz: db95a549cd0d1f3ee086ad35634cf53f94e615de679dd201a543432337e99de43cf9b080d9c10296a0e1e2391e48bedf16717fd868fe7ec7ecae3c35ce7bb384

data/.all-contributorsrc

@@ -214,6 +214,16 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "Mbuckley0",
+      "name": "Mitchell Buckley",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11203679?v=4",
+      "profile": "https://github.com/Mbuckley0",
+      "contributions": [
+        "code",
+        "doc"
+      ]
     }
   ],
   "repoType": "github"

data/.github/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# :pray: Contributing
+
+Thank you for considering or deciding to contribute, this is much appreciated!
+Any kind of bug reports and pull requests are encouraged and welcome on GitHub at
+https://github.com/renderedtext/render_async.
+
+## :inbox_tray: Installing dependencies
+
+You can install all needed dependencies by running `bin/setup`.
+
+## :runner: Running RSpec tests
+
+You can run either `rake spec` or `bundle exec rspec` to run all the RSpec tests
+in the project.
+
+## :running_woman: Running integration tests
+
+There is a simple command `bin/integration-tests` which sets up 2 submodules,
+and runs Cucumber features in them.
+
+There are 2 submodules for render_async. The submodules are Rails 5 and Rails 6
+projects which are located in:
+
+  - `spec/fixtures/rails-5-base-app`, and
+  - `spec/fixtures/rails-6-base-app`.
+
+You can find [Rails 5 base app here](https://github.com/nikolalsvk/rails-5-base-app/tree/render-async),
+and the [Rails 6 base app here](https://github.com/nikolalsvk/rails-6-base-app/tree/render-async).
+
+Each of them have different use cases of render_async defined in `app/views/render_asyncs/_use_cases.html.erb` in their repos.
+All the feature tests are inside `features/render_async.feature` and `features/render_async_jquery.feature` files.
+
+If you are adding one or more feature tests or use cases, make sure to make a
+PR on those repos as well and include them in the PR on the render_async repo.
+
+## :sos: Need help?
+
+Got any issues or difficulties?
+Join [render_async's Discord channel](https://discord.gg/SPfbeRm)
+and ask questions there. We will try to respond to you as quickly as possible.

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.gitmodules

@@ -2,3 +2,7 @@
 	path = spec/fixtures/rails-5-base-app
 	url = git@github.com:nikolalsvk/rails-5-base-app.git
 	branch = render-async
+[submodule "spec/fixtures/rails-6-base-app"]
+	path = spec/fixtures/rails-6-base-app
+	url = git@github.com:nikolalsvk/rails-6-base-app.git
+	branch = render-async

data/README.md

@@ -82,7 +82,7 @@ And then execute:
     <%= render_async comment_stats_path %>
     ```
 
-2. Then create a route that will `config/routes.rb`:
+2. Then create a route for it `config/routes.rb`:
     ```ruby
     get :comment_stats, controller: :comments
     ```
@@ -130,6 +130,7 @@ Advanced usage includes information on different options, such as:
   - [Caching](#caching)
   - [Doing non-GET requests](#doing-non-get-requests)
   - [Using with Turbolinks](#using-with-turbolinks)
+  - [Using with Turbo](#using-with-turbo)
   - [Using with respond_to and JS format](#using-with-respond_to-and-js-format)
   - [Nested async renders](#nested-async-renders)
   - [Customizing the content_for name](#customizing-the-content_for-name)
@@ -198,7 +199,7 @@ Rendered code in the view:
 </div>
 ```
 
-> :bulb:  You can enable `nonce` to be set everywhere by using [configuration option](#configuration-option) render_async provides.
+> :bulb:  You can enable `nonce` to be set everywhere by using [configuration option](#configuration-options) render_async provides.
 
 ### Passing in an HTML element name
 
@@ -291,7 +292,7 @@ document.addEventListener("users-loaded", function(event) {
 ### Using default events
 
 `render_async` will fire the event `render_async_load` when an async partial
-has loaded and rendered on page.
+has loaded and rendered on the page.
 
 In case there is an error, the event `render_async_error` will fire instead.
 
@@ -384,7 +385,7 @@ failure. In the end, if the request is still failing after 5th time, it will
 dispatch a [default error event](#using-default-events).
 
 > :candy:  If you are catching an event after an error, you can get `retryCount` from
-the event. `retryCount` will have number of retries it took before the event was dispatched.
+the event. `retryCount` will have the number of retries it took before the event was dispatched.
 
 Here is an example on how to get `retryCount`:
 
@@ -415,7 +416,7 @@ do this by doing the following:
 ```
 
 This will trigger `render_async` to load the `comments_path` when you click the `#comments-button` element.
-If you want to remove event once it's triggered, you can pass `once: true` in the toggle options.
+If you want to remove an event once it's triggered, you can pass `once: true` in the toggle options.
 The `once` option is false (`nil`) by default.
 
 You can also pass in a placeholder before the `render_async` is triggered. That
@@ -460,7 +461,7 @@ loading" button.
 ### Polling
 
 You can call `render_async` with interval argument. This will make render_async
-call specified path at specified interval.
+call specified path at the specified interval.
 
 By doing this:
 ```erb
@@ -470,8 +471,8 @@ You are telling `render_async` to fetch comments_path every 5 seconds.
 
 This can be handy if you want to enable polling for a specific URL.
 
-> :warning:  By passing interval to `render_async`, initial container element
-> will remain in HTML tree, it will not be replaced with request response.
+> :warning:  By passing interval to `render_async`, the initial container element
+> will remain in the HTML tree and it will not be replaced with request response.
 > You can handle how that container element is rendered and its style by
 > [passing in an HTML element name](#passing-in-an-html-element-name) and
 > [HTML element class](#passing-in-a-container-class-name).
@@ -483,8 +484,8 @@ First one is pretty simple, and it involves using the [toggle](#toggle-event)
 feature. To do this, you can follow instructions in the
 [control polling with a toggle section](#control-polling-with-a-toggle).
 
-Second option is more advanced and it involves emitting events to the `render_async`'s
-container element. From your code, you can emit following events:
+The second option is more advanced and it involves emitting events to the `render_async`'s
+container element. From your code, you can emit the following events:
   - 'async-stop' - this will stop polling
   - 'async-start' - this will start polling.
 
@@ -522,13 +523,13 @@ An example of how you can do this looks like this:
 ```
 
 We are rendering two buttons - "Stop polling" and "Start polling". Then, we
-attach event listener to catch any clicking on the buttons. When the buttons
-are clicked, we either stop the polling, or start the polling, depending which
+attach an event listener to catch any clicking on the buttons. When the buttons
+are clicked, we either stop the polling or start the polling, depending on which
 button a user clicks.
 
 ### Handling errors
 
-`render_async` let's you handle errors by allowing you to pass in `error_message`
+`render_async` lets you handle errors by allowing you to pass in `error_message`
 and `error_event_name`.
 
 - `error_message`
@@ -615,7 +616,7 @@ end
 ```
 
 This way, you're not breaking Turbolinks flow of loading or reloading a page.
-It makes it more efficient that the next option that is suggested below.
+It is more efficient than the next option below.
 
 Another option:
 If you want, you can tell Turbolinks to reload your `render_async` call as follows:
@@ -626,8 +627,38 @@ If you want, you can tell Turbolinks to reload your `render_async` call as follo
 
 This will reload the whole page with Turbolinks.
 
-> :bulb:  Make sure to put `<%= content_for :render_async %>` in your base view file in
-the `<head>` and not the `<body>`.
+> :bulb:  If Turbolinks is misbehaving in some way, make sure to put `<%= content_for :render_async %>` in your base view file in
+the `<body>` and not the `<head>`.
+
+### Using with Turbo
+
+On Turbo applications, you may experience caching issues when navigating
+away from, and then back to, a page with a `render_async` call on it. This will
+likely show up as an empty div.
+
+If you're using Turbo, you can resolve this by setting Turbo
+configuration of `render_async` to true:
+
+```rb
+RenderAsync.configure do |config|
+  config.turbo = true # Enable this option if you are using Turbo
+end
+```
+
+This way, you're not breaking Turbos flow of loading or reloading a page.
+It is more efficient than the next option below.
+
+Another option:
+If you want, you can tell Turbo to reload your `render_async` call as follows:
+
+```erb
+<%= render_async events_path, 'data-turbo-track': 'reload' %>
+```
+
+This will reload the whole page with Turbo.
+
+> :bulb:  If Turbo is misbehaving in some way, make sure to put `<%= content_for :render_async %>` in your base view file in
+the `<body>` and not the `<head>`.
 
 ### Using with respond_to and JS format
 
@@ -646,7 +677,7 @@ def comment_stats
 end
 ```
 
-When you do this, Rails will sometime set the response's `Content-Type` header
+When you do this, Rails will sometimes set the response's `Content-Type` header
 to `text/javascript`. This causes the partial not to be rendered in the HTML.
 This usually happens when there's browser caching.
 
@@ -712,8 +743,9 @@ You can configure it by doing the following anywhere before you call
 RenderAsync.configure do |config|
   config.jquery = true # This will render jQuery code, and skip Vanilla JS code. The default value is false.
   config.turbolinks = true # Enable this option if you are using Turbolinks 5+. The default value is false.
+  config.turbo = true # Enable this option if you are using Turbo. The default value is false.
   config.replace_container = false # Set to false if you want to keep the placeholder div element from render_async. The default value is true.
-  config.nonces = true # Set to true if you want render_async's javascript_tag to always receive nonce: true. The default value is false.
+  config.nonces = true # Set to true if you want render_async's javascript_tag always to receive nonce: true. The default value is false.
 end
 ```
 
@@ -726,7 +758,8 @@ RenderAsync.configuration.jquery = true
 Aside from configuring whether the gem relies on jQuery or VanillaJS, you can
 configure other options:
 
-- `turbolinks` option - If you are using Turbolinks 5+, you should enable this option since it supports Turbolinks way of loading data. The default value for this options if false.
+- `turbolinks` option - If you are using Turbolinks 5+, you should enable this option since it supports Turbolinks way of loading data. The default value for this option is false.
+- `turbo` option - If you are using Turbo, you should enable this option since it supports Turbo way of loading data. The default value for this option is false.
 - `replace_container` option - If you want render_async to replace its container with the request response, turn this on. You can turn this on globally for all render_async calls, but if you use this option in a specific render_async call, it will override the global configuration. The default value is true.
 - `nonces` - If you need to pass in `nonce: true` to the `javascript_tag` in your application, it might make sense for you to turn this on globally for all render_async calls. To read more about nonces, check out [Rails' official guide on security](https://edgeguides.rubyonrails.org/security.html). The default value is false.
 
@@ -735,7 +768,7 @@ configure other options:
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` to run the tests. You can also run `bin/console` for an interactive
 prompt that will allow you to experiment. To run integration tests, use
-`bin/integration-tests`.
+`bin/integration-tests`. For more information, check out [CONTRIBUTING](.github/CONTRIBUTING.md) file, please.
 
 Got any questions or comments about development (or anything else)?
 Join [render_async's Discord channel](https://discord.gg/SPfbeRm)
@@ -743,9 +776,7 @@ and let's make `render_async` even better!
 
 ## :pray: Contributing
 
-Thank you for considering or deciding to contribute, this is much appreciated!
-Any kind of bug reports and pull requests are encouraged and welcome on GitHub at
-https://github.com/renderedtext/render_async.
+Check out [CONTRIBUTING](.github/CONTRIBUTING.md) file, please.
 
 Got any issues or difficulties?
 Join [render_async's Discord channel](https://discord.gg/SPfbeRm)
@@ -765,7 +796,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
 | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
 | [<img src="https://avatars3.githubusercontent.com/u/50223?v=4" width="100px;"/><br /><sub><b>Ernest Surudo</b></sub>](http://elsurudo.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=elsurudo "Code") | [<img src="https://avatars1.githubusercontent.com/u/334809?v=4" width="100px;"/><br /><sub><b>Kurtis Rainbolt-Greene</b></sub>](https://kurtis.rainbolt-greene.online)<br />[💻](https://github.com/renderedtext/render_async/commits?author=krainboltgreene "Code") | [<img src="https://avatars2.githubusercontent.com/u/59744?v=4" width="100px;"/><br /><sub><b>Richard Schneeman</b></sub>](https://www.schneems.com)<br />[📖](https://github.com/renderedtext/render_async/commits?author=schneems "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/75705?v=4" width="100px;"/><br /><sub><b>Richard Venneman</b></sub>](https://www.cityspotters.com)<br />[📖](https://github.com/renderedtext/render_async/commits?author=richardvenneman "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/381395?v=4" width="100px;"/><br /><sub><b>Filipe W. Lima</b></sub>](https://github.com/filipewl)<br />[📖](https://github.com/renderedtext/render_async/commits?author=filipewl "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/3135638?v=4" width="100px;"/><br /><sub><b>Jesús Eduardo Clemens Chong</b></sub>](https://github.com/eclemens)<br />[💻](https://github.com/renderedtext/render_async/commits?author=eclemens "Code") | [<img src="https://avatars3.githubusercontent.com/u/1935686?v=4" width="100px;"/><br /><sub><b>René Klačan</b></sub>](https://github.com/reneklacan)<br />[💻](https://github.com/renderedtext/render_async/commits?author=reneklacan "Code") |
 | [<img src="https://avatars1.githubusercontent.com/u/1313442?v=4" width="100px;"/><br /><sub><b>Gil Gomes</b></sub>](http://gilgomes.com.br)<br />[📖](https://github.com/renderedtext/render_async/commits?author=gil27 "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/6081795?v=4" width="100px;"/><br /><sub><b>Khoa Nguyen</b></sub>](https://github.com/ThanhKhoaIT)<br />[💻](https://github.com/renderedtext/render_async/commits?author=ThanhKhoaIT "Code") [📖](https://github.com/renderedtext/render_async/commits?author=ThanhKhoaIT "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/8645918?v=4" width="100px;"/><br /><sub><b>Preet Sethi</b></sub>](https://www.linkedin.com/in/preetsethila/)<br />[💻](https://github.com/renderedtext/render_async/commits?author=preetsethi "Code") | [<img src="https://avatars3.githubusercontent.com/u/11586335?v=4" width="100px;"/><br /><sub><b>fangxing</b></sub>](https://github.com/fffx)<br />[💻](https://github.com/renderedtext/render_async/commits?author=fffx "Code") | [<img src="https://avatars3.githubusercontent.com/u/1191418?v=4" width="100px;"/><br /><sub><b>Emmanuel Pire</b></sub>](http://blog.lipsumarium.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=lipsumar "Code") [📖](https://github.com/renderedtext/render_async/commits?author=lipsumar "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/615509?v=4" width="100px;"/><br /><sub><b>Maxim Geerinck</b></sub>](https://github.com/maximgeerinck)<br />[💻](https://github.com/renderedtext/render_async/commits?author=maximgeerinck "Code") | [<img src="https://avatars1.githubusercontent.com/u/251706?v=4" width="100px;"/><br /><sub><b>Don</b></sub>](https://github.com/vanboom)<br />[💻](https://github.com/renderedtext/render_async/commits?author=vanboom "Code") |
-| [<img src="https://avatars0.githubusercontent.com/u/998682?v=4" width="100px;"/><br /><sub><b>villu164</b></sub>](https://github.com/villu164)<br />[📖](https://github.com/renderedtext/render_async/commits?author=villu164 "Documentation") |
+| [<img src="https://avatars0.githubusercontent.com/u/998682?v=4" width="100px;"/><br /><sub><b>villu164</b></sub>](https://github.com/villu164)<br />[📖](https://github.com/renderedtext/render_async/commits?author=villu164 "Documentation") | [<img src="https://avatars.githubusercontent.com/u/11203679?v=4" width="100px;"/><br /><sub><b>Mitchell Buckley</b></sub>](https://github.com/Mbuckley0)<br />[💻](https://github.com/renderedtext/render_async/commits?author=Mbuckley0 "Code") [📖](https://github.com/renderedtext/render_async/commits?author=Mbuckley0 "Documentation") |
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

data/app/views/render_async/_render_async.html.erb

@@ -20,7 +20,8 @@
                   retry_count: retry_count,
                   retry_delay: retry_delay,
                   interval: interval,
-                  turbolinks: RenderAsync.configuration.turbolinks } %>
+                  turbolinks: RenderAsync.configuration.turbolinks,
+                  turbo: RenderAsync.configuration.turbo} %>
 
     <% if RenderAsync.configuration.jquery %>
       <%= render partial: 'render_async/request_jquery',

data/app/views/render_async/_request_jquery.js.erb

@@ -5,6 +5,11 @@ if (window.jQuery) {
       return;
     }
     <% end %>
+    <% if turbo %>
+    if (document.documentElement.hasAttribute("data-turbo-preview")) {
+      return;
+    }
+    <% end %>
     function createEvent(name, container) {
       var event = undefined;
       if (typeof(Event) === 'function') {
@@ -24,6 +29,8 @@ if (window.jQuery) {
       } else {
         <% if turbolinks %>
         $(document).one('turbolinks:load', callback);
+        <% elsif turbo %>
+        $(document).one('turbo:load', callback);
         <% else %>
         $(document).ready(callback);
         <% end %>
@@ -137,6 +144,9 @@ if (window.jQuery) {
     <% if turbolinks %>
     $(document).one('turbolinks:visit', _clearRenderAsyncInterval);
     <% end %>
+    <% if turbo %>
+    $(document).one('turbo:visit', _clearRenderAsyncInterval);
+    <% end %>
     <% end %>
 
     <% if !replace_container %>

data/app/views/render_async/_request_vanilla.js.erb

@@ -4,6 +4,11 @@
     return;
   }
   <% end %>
+  <% if turbo %>
+  if (document.documentElement.hasAttribute("data-turbo-preview")) {
+    return;
+  }
+  <% end %>
   function createEvent(name, container) {
     var event = undefined;
     if (typeof(Event) === 'function') {
@@ -22,6 +27,11 @@
       e.target.removeEventListener(e.type, arguments.callee);
       callback();
     });
+    <% elsif turbo %>
+    document.addEventListener("turbo:load", function(e) {
+      e.target.removeEventListener(e.type, arguments.callee);
+      callback();
+    });
     <% else %>
     document.addEventListener("DOMContentLoaded", callback);
     <% end %>
@@ -147,6 +157,9 @@
   <% if turbolinks %>
   document.addEventListener("turbolinks:visit", _clearRenderAsyncInterval)
   <% end %>
+  <% if turbo %>
+  document.addEventListener("turbo:visit", _clearRenderAsyncInterval)
+  <% end %>
   <% end %>
 
   <% if !replace_container %>

data/bin/integration-tests

@@ -11,3 +11,10 @@ cd spec/fixtures/rails-5-base-app
 ls
 bundle install
 bundle exec cucumber
+
+cd ../../../spec/fixtures/rails-6-base-app
+ls
+bundle install
+yarn install
+RAILS_ENV=test bundle exec rails webpacker:compile
+bundle exec cucumber

data/lib/render_async/configuration.rb

@@ -1,10 +1,11 @@
 module RenderAsync
   class Configuration
-    attr_accessor :jquery, :turbolinks, :replace_container, :nonces
+    attr_accessor :jquery, :turbolinks, :turbo, :replace_container, :nonces
 
     def initialize
       @jquery = false
       @turbolinks = false
+      @turbo = false
       @replace_container = true
       @nonces = false
     end

data/lib/render_async/version.rb

@@ -1,3 +1,3 @@
 module RenderAsync
-  VERSION = "2.1.8".freeze
+  VERSION = "2.1.9".freeze
 end

data/lib/render_async/view_helper.rb

@@ -44,7 +44,7 @@ module RenderAsync
     def html_options(options)
       set_options = options.delete(:html_options) || {}
 
-      set_options[:nonce] = config.nonces if set_options[:nonce].nil?
+      set_options[:nonce] = configuration.nonces if set_options[:nonce].nil?
 
       set_options
     end
@@ -85,10 +85,10 @@ module RenderAsync
     def replace_container(options)
       return options[:replace_container] unless options[:replace_container].nil?
 
-      config.replace_container
+      configuration.replace_container
     end
 
-    def config
+    def configuration
       RenderAsync.configuration
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.1.9
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-24 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".all-contributorsrc"
+- ".github/CONTRIBUTING.md"
 - ".github/FUNDING.yml"
 - ".gitignore"
 - ".gitmodules"