render_async 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cb50b82faad4e5b955dee426984e606277e5000
-  data.tar.gz: 30b577cb393842086bb39b0b52c3913d62cec3c0
+  metadata.gz: aec789eda10aa5db3c538756631ee0e6963c6f5e
+  data.tar.gz: 424668e8679890bbf1b8d37bf4ec1e56a7c7cbaf
 SHA512:
-  metadata.gz: cefdcad421559d06858b1b13e9e70f6c4c79781d7dbb8255ea6265c4e09079733092ea25238c7610c0e803c326b11f8fe34ff50bd953582cdf3ca4fcf4a1bea6
-  data.tar.gz: e01ae7a2d71bec7d25f853e0edc640b3f83786e1d3143943e0eee46ab549584fa9b1280f19f5359b52105525cc19c066658a753524735672a6ae2aca5e234e70
+  metadata.gz: 6cd574849e185137bf16f02b7502ea4f3d0d18deedbf383b289e8f5ee0455c49d55a077f298b01a4338730e5198dda222dc2fbdb03ebe99964ba615b7763c555
+  data.tar.gz: 508546ce17b2ffad8e730c1050dc484b266dfb894318c5c8b9693e8e48a53e3ff42555970840d1bec4ade0dcc6b029ca5349437d51d1d8f8f575551c213f4858

data/.all-contributorsrc

@@ -58,6 +58,25 @@
         "code",
         "doc"
       ]
+    },
+    {
+      "login": "SaladFork",
+      "name": "Elad Shahar",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/107798?v=4",
+      "profile": "https://eladshahar.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "sasharevzin",
+      "name": "Sasha",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/232392?v=4",
+      "profile": "http://www.revzin.co.il",
+      "contributions": [
+        "code",
+        "doc"
+      ]
     }
   ]
 }

data/README.md

@@ -1,18 +1,22 @@
 [![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-5-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-7-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)
 
 ![render_async](https://semaphoreci.com/blog/assets/images/2017-06-08/speed-up-rendering-rails-pages-with-render-async-6c40eb39.png)
 
 # render_async
 
-Renders partials to your views **asynchronously**. This is done through adding
-Javascript code that does AJAX request to your controller which then renders
-your partial.
+Speed up rendering Rails pages with this gem.
+
+`render_async` renders partials to your views **asynchronously**. This is done
+through adding Javascript code that does AJAX request to your controller which
+then renders your partial into a Rails view.
 
 Workflow:
 
-1. user visits a page
+1. user visits a Rails page
 2. AJAX request on the controller action
 3. controller renders a partial
 4. partials renders in the place where you put `render_async` helper
@@ -98,13 +102,21 @@ Rendered code in the view:
 
 <script nonce="lWaaV6eYicpt+oyOfcShYINsz0b70iR+Q1mohZqNaag=">
 //<![CDATA[
-
-    (function($){
-      $.ajax({ url: "/users" }).always(function(response) {
-        $("#render_async_18b8a6cd161499117471").replaceWith(response);
-      });
-    }(jQuery));
-
+  (function() {
+    var request = new XMLHttpRequest();
+    var asyncRequest = true;
+    var SUCCESS = 200;
+    var ERROR = 400;
+    request.open("GET", "/users", asyncRequest);
+
+    request.onload = function() {
+      if (request.status >= SUCCESS && request.status < ERROR) {
+        document.getElementById("render_async_18b41794481507226109").outerHTML = request.responseText;
+      }
+    };
+
+    request.send();
+  })();
 //]]>
 </script>
 ```
@@ -130,13 +142,21 @@ Rendered code in the view:
 
 <script>
 //<![CDATA[
-
-    (function($){
-      $.ajax({ url: "/users" }).always(function(response) {
-        $("#render_async_14d7ac165d1505993721").replaceWith(response);
-      });
-    }(jQuery));
-
+  (function() {
+    var request = new XMLHttpRequest();
+    var asyncRequest = true;
+    var SUCCESS = 200;
+    var ERROR = 400;
+    request.open("GET", "/users", asyncRequest);
+
+    request.onload = function() {
+      if (request.status >= SUCCESS && request.status < ERROR) {
+        document.getElementById("render_async_14d7ac165d1505993721").outerHTML = request.responseText;
+      }
+    };
+
+    request.send();
+  })();
 //]]>
 </script>
 ```
@@ -172,6 +192,18 @@ In your views:
 * You can expire cache simply by passing `:expires_in` in your view where
   you cache the partial
 
+## 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
+likely show up as an empty div.
+
+To resolve, tell turbolinks to reload your `render_async` call as follows:
+
+```erb
+  <%= render_async events_path, 'data-turbolinks-track': 'reload' %>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -197,8 +229,8 @@ 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://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") |
+| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
 <!-- 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

@@ -4,10 +4,21 @@
 
 <% content_for :render_async do %>
   <%= javascript_tag html_options do %>
-    (function($){
-      $.ajax({ url: "<%= path %>" }).always(function(response) {
-        $("#<%= container_id %>").replaceWith(response);
-      });
-    }(jQuery));
+    (function() {
+      var request = new XMLHttpRequest();
+      var asyncRequest = true;
+      var SUCCESS = 200;
+      var ERROR = 400;
+
+      request.open("GET", "<%= path %>", asyncRequest);
+
+      request.onload = function() {
+        if (request.status >= SUCCESS && request.status < ERROR) {
+          document.getElementById("<%= container_id %>").outerHTML = request.responseText;
+        }
+      };
+
+      request.send();
+    })();
   <% end %>
 <% end %>

data/lib/render_async/version.rb

@@ -1,3 +1,3 @@
 module RenderAsync
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/render_async.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
 description: Load parts of your page through simple Javascript and Rails pipeline
 email:
 - nikolaseap@gmail.com
@@ -95,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Render parts of the page asynchronously with AJAX