render_async 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c603221d8623559e475f5dd31847ca30d86c3a6a
-  data.tar.gz: 54c76dde479ea0cfc2c500126f419752e50749a6
+  metadata.gz: f1e55f1d2d9bd896fcb28007fb3bfe42752d4d90
+  data.tar.gz: ac66f3e90a93a3952b0b5f690ab1d79e85b2284c
 SHA512:
-  metadata.gz: b111b20c0440b3933b687469f851521b17163b31b5b312b180d1c7393b5b1222f96704832b52ca61d8e6dbb013ece9bf45ee2625a977b2f8083aa1bb1ac16461
-  data.tar.gz: c5853c4de18b1c7af54980e5656a1badcb3d9e39c9005eb133a5f3ce1b93bafadd795b1a5e8b8fa6523a1c23f0925a15e806d37a4ba3782fc5f943972e70e368
+  metadata.gz: 43ffe5cf4db879ec44baf27f68435ef275206ce725085ae6c6f1f139c44fcafd215e41b79ce0b44c471698a4b2cf21353e6ae9f07bd95620321f121551d0c49b
+  data.tar.gz: 089b856889e18dd218372284ee4cfe86dd8aa08260ad55b58e39334a694e981de7c407a237a3686bbe69c71109bbc36c29bfb90163404b0d7efeaefa1db34389

data/.all-contributorsrc

@@ -28,7 +28,8 @@
       "profile": "http://www.colinxfleming.com",
       "contributions": [
         "code",
-        "doc"
+        "doc",
+        "example"
       ]
     },
     {
@@ -65,7 +66,8 @@
       "avatar_url": "https://avatars3.githubusercontent.com/u/107798?v=4",
       "profile": "https://eladshahar.com",
       "contributions": [
-        "code"
+        "code",
+        "example"
       ]
     },
     {
@@ -86,6 +88,24 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "krainboltgreene",
+      "name": "Kurtis Rainbolt-Greene",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/334809?v=4",
+      "profile": "https://kurtis.rainbolt-greene.online",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "schneems",
+      "name": "Richard Schneeman",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/59744?v=4",
+      "profile": "https://www.schneems.com",
+      "contributions": [
+        "doc"
+      ]
     }
   ]
 }

data/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "spec/fixtures/rails-5-base-app"]
+	path = spec/fixtures/rails-5-base-app
+	url = git@github.com:nikolalsvk/rails-5-base-app.git
+	branch = render-async

data/README.md

@@ -1,8 +1,9 @@
 [![Build Status](https://semaphoreci.com/api/v1/renderedtext/render_async/branches/master/shields_badge.svg)](https://semaphoreci.com/renderedtext/render_async)
-[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors)
 [![Gem Version](https://badge.fury.io/rb/render_async.svg)](https://badge.fury.io/rb/render_async)
 [![Code Climate](https://codeclimate.com/github/renderedtext/render_async/badges/gpa.svg)](https://codeclimate.com/github/renderedtext/render_async)
 [![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)
 
@@ -71,6 +72,16 @@ And then execute:
 
 ## Advanced usage
 
+Advanced usage includes information on different options, such as:
+
+  - [Passing in HTML options](#passing-in-html-options)
+  - [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)
+  - [Caching](#caching)
+  - [Using with Turbolinks](#using-with-turbolinks)
+  - [Nested Async Renders](#nested-async-renders)
+
 ### Passing in HTML options
 
 `render_async` takes two arguments, `path` and `html_options`.
@@ -97,6 +108,26 @@ Rendered code in the view:
 </script>
 ```
 
+### Passing in an HTML element name
+
+`render_async` can take in an HTML element name, allowing you to control
+what type of container gets rendered. This can be useful when you're using
+[`render_async` inside a table](https://github.com/renderedtext/render_async/issues/12)
+and you need it to render a `tr` element before your request gets loaded, so
+your content doesn't get pushed out of the table.
+
+Example of using HTML element name:
+```erb
+<%= render_async users_path, html_element_name: 'tr' %>
+```
+
+Rendered code in the view:
+```html
+<tr id="render_async_04229e7abe1507987376">
+</tr>
+...
+```
+
 ### Passing in a placeholder
 
 `render_async` can be called with a block that will act as a placeholder before
@@ -160,7 +191,7 @@ document.addEventListener("users-loaded", function() {
 });
 ```
 
-## Caching
+### Caching
 
 `render_async` can utilize view fragment caching to avoid extra AJAX calls.
 
@@ -185,7 +216,7 @@ Then, in the partial (e.g. `app/views/comments/_comment_stats.html.erb`):
 * You can expire cache simply by passing `:expires_in` in your view where
   you cache the partial
 
-## Using with Turbolinks
+### Using with Turbolinks
 
 On Turbolinks 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
@@ -197,6 +228,33 @@ To resolve, tell turbolinks to reload your `render_async` call as follows:
 <%= render_async events_path, 'data-turbolinks-track': 'reload' %>
 ```
 
+### Nested Async Renders
+
+It is possible to nest async templates within other async templates. When doing
+so, another `content_for` is required to ensure the JavaScript needed to load
+nested templates is included.
+
+For example:
+```erb
+<%# app/views/comments/show.html.erb %>
+
+<%= render_async comment_stats_path %>
+```
+
+```erb
+<%# app/views/comments/_comment_stats.html.erb %>
+
+<div class="col-md-6">
+  <%= @stats %>
+</div>
+
+<div class="col-md-6">
+  <%= render_async comment_advanced_stats_path %>
+</div>
+
+<%= content_for :render_async %>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -216,9 +274,9 @@ The gem is available as open source under the terms of the [MIT License](http://
 Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-| [<img src="https://avatars2.githubusercontent.com/u/3028124?v=4" width="100px;"/><br /><sub>Nikola Đuza</sub>](http://nikoladjuza.me/)<br />[💬](#question-nikolalsvk "Answering Questions") [🐛](https://github.com/renderedtext/render_async/issues?q=author%3Anikolalsvk "Bug reports") [💻](https://github.com/renderedtext/render_async/commits?author=nikolalsvk "Code") [📖](https://github.com/renderedtext/render_async/commits?author=nikolalsvk "Documentation") [💡](#example-nikolalsvk "Examples") [👀](#review-nikolalsvk "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/3866868?v=4" width="100px;"/><br /><sub>Colin</sub>](http://www.colinxfleming.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=colinxfleming "Code") [📖](https://github.com/renderedtext/render_async/commits?author=colinxfleming "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/334273?v=4" width="100px;"/><br /><sub>Kasper Grubbe</sub>](http://kaspergrubbe.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=kaspergrubbe "Code") | [<img src="https://avatars2.githubusercontent.com/u/163584?v=4" width="100px;"/><br /><sub>Sai Ram Kunala</sub>](https://sairam.xyz/)<br />[📖](https://github.com/renderedtext/render_async/commits?author=sairam "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/3065882?v=4" width="100px;"/><br /><sub>Josh Arnold</sub>](https://github.com/nightsurge)<br />[💻](https://github.com/renderedtext/render_async/commits?author=nightsurge "Code") [📖](https://github.com/renderedtext/render_async/commits?author=nightsurge "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/107798?v=4" width="100px;"/><br /><sub>Elad Shahar</sub>](https://eladshahar.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=SaladFork "Code") | [<img src="https://avatars3.githubusercontent.com/u/232392?v=4" width="100px;"/><br /><sub>Sasha</sub>](http://www.revzin.co.il)<br />[💻](https://github.com/renderedtext/render_async/commits?author=sasharevzin "Code") [📖](https://github.com/renderedtext/render_async/commits?author=sasharevzin "Documentation") |
+| [<img src="https://avatars2.githubusercontent.com/u/3028124?v=4" width="100px;"/><br /><sub>Nikola Đuza</sub>](http://nikoladjuza.me/)<br />[💬](#question-nikolalsvk "Answering Questions") [🐛](https://github.com/renderedtext/render_async/issues?q=author%3Anikolalsvk "Bug reports") [💻](https://github.com/renderedtext/render_async/commits?author=nikolalsvk "Code") [📖](https://github.com/renderedtext/render_async/commits?author=nikolalsvk "Documentation") [💡](#example-nikolalsvk "Examples") [👀](#review-nikolalsvk "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/3866868?v=4" width="100px;"/><br /><sub>Colin</sub>](http://www.colinxfleming.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=colinxfleming "Code") [📖](https://github.com/renderedtext/render_async/commits?author=colinxfleming "Documentation") [💡](#example-colinxfleming "Examples") | [<img src="https://avatars2.githubusercontent.com/u/334273?v=4" width="100px;"/><br /><sub>Kasper Grubbe</sub>](http://kaspergrubbe.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=kaspergrubbe "Code") | [<img src="https://avatars2.githubusercontent.com/u/163584?v=4" width="100px;"/><br /><sub>Sai Ram Kunala</sub>](https://sairam.xyz/)<br />[📖](https://github.com/renderedtext/render_async/commits?author=sairam "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/3065882?v=4" width="100px;"/><br /><sub>Josh Arnold</sub>](https://github.com/nightsurge)<br />[💻](https://github.com/renderedtext/render_async/commits?author=nightsurge "Code") [📖](https://github.com/renderedtext/render_async/commits?author=nightsurge "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/107798?v=4" width="100px;"/><br /><sub>Elad Shahar</sub>](https://eladshahar.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=SaladFork "Code") [💡](#example-SaladFork "Examples") | [<img src="https://avatars3.githubusercontent.com/u/232392?v=4" width="100px;"/><br /><sub>Sasha</sub>](http://www.revzin.co.il)<br />[💻](https://github.com/renderedtext/render_async/commits?author=sasharevzin "Code") [📖](https://github.com/renderedtext/render_async/commits?author=sasharevzin "Documentation") |
 | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
-| [<img src="https://avatars3.githubusercontent.com/u/50223?v=4" width="100px;"/><br /><sub>Ernest Surudo</sub>](http://elsurudo.com)<br />[💻](https://github.com/renderedtext/render_async/commits?author=elsurudo "Code") |
+| [<img src="https://avatars3.githubusercontent.com/u/50223?v=4" width="100px;"/><br /><sub>Ernest Surudo</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>Kurtis Rainbolt-Greene</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>Richard Schneeman</sub>](https://www.schneems.com)<br />[📖](https://github.com/renderedtext/render_async/commits?author=schneems "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

@@ -1,41 +1,13 @@
-<div id="<%= container_id %>">
+<<%= html_element_name %> id="<%= container_id %>">
   <%= placeholder %>
-</div>
+</<%= html_element_name %>>
 
 <% content_for :render_async do %>
   <%= javascript_tag html_options do %>
-    if (window.jQuery) {
-      (function($){
-        $.ajax({ url: "<%= path.html_safe %>" }).always(function(response) {
-          $("#<%= container_id %>").replaceWith(response);
-
-          <% if event_name.present? %>
-            document.dispatchEvent(new Event("<%= event_name %>"));
-          <% end %>
-        });
-      }(jQuery));
-    } else {
-      (function() {
-        var request = new XMLHttpRequest();
-        var asyncRequest = true;
-        var SUCCESS = 200;
-        var ERROR = 400;
-
-        request.open("GET", "<%= path.html_safe %>", asyncRequest);
-
-        request.onload = function() {
-          if (request.status >= SUCCESS && request.status < ERROR) {
-            var container = document.getElementById("<%= container_id %>");
-            container.outerHTML = request.response;
-
-            <% if event_name.present? %>
-              document.dispatchEvent(new Event("<%= event_name %>"));
-            <% end %>
-          }
-        };
-
-        request.send();
-      })();
-    }
+    <%= render partial: 'render_async/request',
+               formats: [:js],
+               locals:  { container_id: container_id,
+                          path: path,
+                          event_name: event_name } %>
   <% end %>
 <% end %>

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

@@ -0,0 +1,37 @@
+if (window.jQuery) {
+  (function($) {
+    $(document).ready(function() {
+      $.ajax({ url: "<%= path.html_safe %>" }).always(function(response) {
+        $("#<%= container_id %>").replaceWith(response);
+
+        <% if event_name.present? %>
+          document.dispatchEvent(new Event("<%= event_name %>"));
+        <% end %>
+      });
+    });
+  }(jQuery));
+} else {
+  (function() {
+    document.addEventListener("DOMContentLoaded", function() {
+      var request = new XMLHttpRequest();
+      var asyncRequest = true;
+      var SUCCESS = 200;
+      var ERROR = 400;
+
+      request.open("GET", "<%= path.html_safe %>", asyncRequest);
+
+      request.onload = function() {
+        if (request.status >= SUCCESS && request.status < ERROR) {
+          var container = document.getElementById("<%= container_id %>");
+          container.outerHTML = request.response;
+
+          <% if event_name.present? %>
+            document.dispatchEvent(new Event("<%= event_name %>"));
+          <% end %>
+        }
+      };
+
+      request.send();
+    });
+  })();
+}

data/bin/integration-tests

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+git submodule init
+git submodule update
+
+gem build render_async.gemspec
+gem install render_async*.gem
+
+cd spec/fixtures/rails-5-base-app
+ls
+bundle install
+bundle exec cucumber

data/lib/render_async/version.rb

@@ -1,3 +1,3 @@
 module RenderAsync
-  VERSION = "1.1.3"
+  VERSION = "1.2.0".freeze
 end

data/lib/render_async/view_helper.rb

@@ -18,11 +18,13 @@ module RenderAsync
     end
 
     def render_async(path, options = {}, &placeholder)
+      html_element_name = options.delete(:html_element_name) || "div"
       container_id = "render_async_#{SecureRandom.hex(5)}#{Time.now.to_i}"
       event_name = options.delete(:event_name)
       placeholder = capture(&placeholder) if block_given?
 
-      render 'render_async/render_async', container_id: container_id,
+      render 'render_async/render_async', html_element_name: html_element_name,
+                                          container_id: container_id,
                                           path: path,
                                           html_options: options,
                                           event_name: event_name,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,13 +76,16 @@ extra_rdoc_files: []
 files:
 - ".all-contributorsrc"
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - app/views/render_async/_render_async.html.erb
+- app/views/render_async/_request.js.erb
 - bin/console
+- bin/integration-tests
 - bin/setup
 - lib/render_async.rb
 - lib/render_async/engine.rb