render_async 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7bdbe323ba586e914af5f41c95a452317c5018b
-  data.tar.gz: ebc1f2cdfe99db8e749249ec3f1b89bd52aa3bcb
+  metadata.gz: bc0f4801636b4b88873e40623ea250d27f35ee11
+  data.tar.gz: e4407a2cd9bfd7cf409dfe0d6846446bb6370db7
 SHA512:
-  metadata.gz: 1d1c360782f7ea323773761617141c62a85f42c54e692e9ca9a0243ad03eb0e083073bb3d848511a0501001b52a47d30763edf9ba16afaccaeb9e7d53e872d06
-  data.tar.gz: ea5c1b9f074e5d55276a26f694883daeb42dd93ce9ecc13b2eb4e271cc6212e30c94f0dc22501324fe4294ff6ac094ebca0cb8cf471fe30f87c4279aa92c1db1
+  metadata.gz: 5ea2036461e908f64a6d3ee180a28663052f31393f1a7c600cc8a3ec7319b2bfbd4a6c7e5534175f933accc944c154d3b2e6629e69f0feaf71b46f7b02f2b343
+  data.tar.gz: d4df153331955b0bef1111e5a9095f8ab01568bd69bbfe1bca014a5423e7d71f11859658ec27d2a356b565ce25346c8331b30ad57fb7d7b60f16ba18941e1738

data/README.md

@@ -5,7 +5,7 @@
 [![Test Coverage](https://codeclimate.com/github/renderedtext/render_async/badges/coverage.svg)](https://codeclimate.com/github/renderedtext/render_async/coverage)
 [![Help Contribute to Open Source](https://www.codetriage.com/renderedtext/render_async/badges/users.svg)](https://www.codetriage.com/renderedtext/render_async)
 
-![render_async](https://semaphoreci.com/blog/assets/images/2017-06-08/speed-up-rendering-rails-pages-with-render-async-6c40eb39.png)
+![render_async](http://s2blog.wpengine.com/wp-content/uploads/assets/images/2017-06-08/speed-up-rendering-rails-pages-with-render-async.png)
 
 # render_async
 
@@ -79,6 +79,8 @@ Advanced usage includes information on different options, such as:
   - [Passing in an HTML element name](#passing-in-an-html-element-name)
   - [Passing in a placeholder](#passing-in-a-placeholder)
   - [Passing in an event name](#passing-in-an-event-name)
+  - [Retry on failure](#retry-on-failure)
+  - [Polling](#polling)
   - [Handling errors](#handling-errors)
   - [Caching](#caching)
   - [Doing non-GET requests](#doing-non-get-requests)
@@ -233,6 +235,42 @@ document.addEventListener("users-loaded", function() {
 NOTE: Dispatching events is also supported for older browsers that don't
 support Event constructor.
 
+### Retry on failure
+
+`render_async` can retry your requests if they fail for some reason.
+
+If you want `render_async` to retry a request for number of times, you can do
+this:
+```erb
+<%= render_async users_path, retry_count: 5, error_message: "Couldn't fetch it" %>
+```
+
+Now render_async will retry `users_path` for 5 times. If it succedes in
+between, it will stop with dispatching requests. If it fails after 5 times,
+it will show an [error message](#handling-errors) which you need to specify.
+
+This can show useful when you know your requests often fail, and you don't want
+to refresh the whole page just to retry them.
+
+### Polling
+
+You can call `render_async` with interval argument. This will make render_async
+call specified path at specified interval.
+
+By doing this:
+```erb
+<%= render_async comments_path, interval: 5000 %>
+```
+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.
+
+NOTE: By passing interval to `render_async`, initial container element
+will remain in HTML tree, 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).
+
 ### Handling errors
 
 `render_async` let's you handle errors by allowing you to pass in `error_message`

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

@@ -18,6 +18,8 @@
                             headers: headers,
                             error_message: error_message,
                             error_event_name: error_event_name,
+                            retry_count: retry_count,
+                            interval: interval,
                             turbolinks: RenderAsync.configuration.turbolinks } %>
     <% else %>
       <%= render partial: 'render_async/request_vanilla',
@@ -30,6 +32,8 @@
                             headers: headers,
                             error_message: error_message,
                             error_event_name: error_event_name,
+                            retry_count: retry_count,
+                            interval: interval,
                             turbolinks: RenderAsync.configuration.turbolinks } %>
     <% end %>
   <% end %>

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

@@ -6,7 +6,7 @@ if (window.jQuery) {
     }
     <% end %>
 
-    var _listener = function() {
+    var _listener = function(currentRetryCount) {
       var headers = <%= headers.to_json.html_safe %>;
       var csrfTokenElement = document.querySelector('meta[name="csrf-token"]')
       if (csrfTokenElement)
@@ -18,7 +18,12 @@ if (window.jQuery) {
         data: "<%= escape_javascript(data.to_s.html_safe) %>",
         headers: headers
       }).done(function(response) {
-        $("#<%= container_id %>").replaceWith(response);
+        <% if interval %>
+          $("#<%= container_id %>").empty();
+          $("#<%= container_id %>").append(response);
+        <% else %>
+          $("#<%= container_id %>").replaceWith(response);
+        <% end %>
 
         <% if event_name.present? %>
           var event = undefined;
@@ -31,6 +36,13 @@ if (window.jQuery) {
           document.dispatchEvent(event);
         <% end %>
       }).fail(function(response) {
+        var skipErrorMessage = false;
+        <% if retry_count > 0 %>
+        skipErrorMessage = retry(currentRetryCount)
+        <% end %>
+
+        if (skipErrorMessage) return;
+
         $("#<%= container_id %>").replaceWith('<%= error_message.try(:html_safe) %>');
 
         <% if error_event_name.present? %>
@@ -46,8 +58,29 @@ if (window.jQuery) {
       });
     };
 
+    <% if retry_count > 0 %>
+    var retry = function(currentRetryCount) {
+      if (typeof(currentRetryCount) === 'number') {
+        if (currentRetryCount >= <%= retry_count %>)
+          return false;
+
+        _listener(currentRetryCount + 1);
+        return true;
+      }
+
+      _listener(1);
+      return true;
+    }
+    <% end %>
+
     <% if turbolinks %>
     $(document).one('turbolinks:load', _listener);
+    <% elsif interval %>
+    var _intervalFunction = function() {
+      _listener();
+      setInterval(_listener, <%= interval %>);
+    }
+    $(document).ready(_intervalFunction);
     <% else %>
     $(document).ready(_listener);
     <% end %>

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

@@ -5,7 +5,7 @@
   }
   <% end %>
   
-  var _listener = function() {
+  var _listener = function(currentRetryCount) {
     var request = new XMLHttpRequest();
     var asyncRequest = true;
     var SUCCESS = 200;
@@ -26,7 +26,11 @@
       if (request.readyState === 4) {
         if (request.status >= SUCCESS && request.status < ERROR) {
           var container = document.getElementById('<%= container_id %>');
+          <% if interval %>
+          container.innerHTML = request.response;
+          <% else %>
           container.outerHTML = request.response;
+          <% end %>
 
           <% if event_name.present? %>
             var event = undefined;
@@ -39,6 +43,13 @@
             document.dispatchEvent(event);
           <% end %>
         } else {
+          var skipErrorMessage = false;
+          <% if retry_count > 0 %>
+          skipErrorMessage = retry(currentRetryCount)
+          <% end %>
+
+          if (skipErrorMessage) return;
+
           var container = document.getElementById('<%= container_id %>');
           container.outerHTML = '<%= error_message.try(:html_safe) %>';
 
@@ -60,11 +71,32 @@
     request.send(body);
   };
 
+  <% if retry_count > 0 %>
+  var retry = function(currentRetryCount) {
+    if (typeof(currentRetryCount) === 'number') {
+      if (currentRetryCount >= <%= retry_count %>)
+        return false;
+
+      _listener(currentRetryCount + 1);
+      return true;
+    }
+
+    _listener(1);
+    return true;
+  }
+  <% end %>
+
   <% if turbolinks %>
   document.addEventListener("turbolinks:load", function (e) {
     e.target.removeEventListener(e.type, arguments.callee);
     _listener.call(this);
   });
+  <% elsif interval %>
+  var _intervalFunction = function() {
+    _listener();
+    setInterval(_listener, <%= interval %>);
+  }
+  document.addEventListener("DOMContentLoaded", _intervalFunction);
   <% else %>
   document.addEventListener("DOMContentLoaded", _listener);
   <% end %>

data/lib/render_async/version.rb

@@ -1,3 +1,3 @@
 module RenderAsync
-  VERSION = "2.0.2".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/render_async/view_helper.rb

@@ -28,6 +28,8 @@ module RenderAsync
       headers = options.delete(:headers) || {}
       error_message = options.delete(:error_message)
       error_event_name = options.delete(:error_event_name)
+      retry_count = options.delete(:retry_count) || 0
+      interval = options.delete(:interval)
 
       render 'render_async/render_async', html_element_name: html_element_name,
                                           container_id: container_id,
@@ -40,7 +42,9 @@ module RenderAsync
                                           data: data,
                                           headers: headers,
                                           error_message: error_message,
-                                          error_event_name: error_event_name
+                                          error_event_name: error_event_name,
+                                          retry_count: retry_count,
+                                          interval: interval
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake