render_async 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c054d37191e7387bd9fadc6c8ab5879c01db45a5
-  data.tar.gz: afaf4b5b8a78464a776a8bf8c0bb3c21e15bac6e
+  metadata.gz: 4cb50b82faad4e5b955dee426984e606277e5000
+  data.tar.gz: 30b577cb393842086bb39b0b52c3913d62cec3c0
 SHA512:
-  metadata.gz: 859086a41d3f75868629eb650639a24bd28aa48c74966a2152545800f6adb0c37dfa3e7d1db7c2e1a90f03cbdeb56777d8f9fb0411527245a97e34124a9213b0
-  data.tar.gz: 750ecc2a1fff9dbdfe518f986084b30dc19633e4859e60ba68ca33d24a75bcd9ba12479f29e9eab51a3b2ec2fba7034011fd712108e35ba371508b8398b0e508
+  metadata.gz: cefdcad421559d06858b1b13e9e70f6c4c79781d7dbb8255ea6265c4e09079733092ea25238c7610c0e803c326b11f8fe34ff50bd953582cdf3ca4fcf4a1bea6
+  data.tar.gz: e01ae7a2d71bec7d25f853e0edc640b3f83786e1d3143943e0eee46ab549584fa9b1280f19f5359b52105525cc19c066658a753524735672a6ae2aca5e234e70

data/README.md

@@ -12,9 +12,9 @@ your partial.
 
 Workflow:
 
-1. user visits a page =>
-2. AJAX request on the controller action =>
-3. controller renders a partial =>
+1. user visits a 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
 
 Javascript is injected into `<%= content_for :render_async %>` so you choose
@@ -77,12 +77,16 @@ And then execute:
 
 ## Advanced usage
 
+### Passing in HTML options
+
 `render_async` takes two arguments, `path` and `html_options`.
 
-* `path` is the ajax-capable controller action you're looking to call via `get`. e.g. `comments_stats_path`, `posts_path`, etc.
-* `html_options` is an optional hash that gets passed to a rails `javascript_tag`, to drop html tags into the `script` element.
+* `path` is the AJAX-capable controller action you're looking to call via
+  `GET`. e.g. `comments_stats_path`, `posts_path`, etc.
+* `html_options` is an optional hash that gets passed to a rails
+  `javascript_tag`, to drop html tags into the `script` element.
 
-Example utilizing `html_options` with a `nonce`:
+Example of utilizing `html_options` with a `nonce`:
 ```erb
 <%= render_async users_path, nonce: 'lWaaV6eYicpt+oyOfcShYINsz0b70iR+Q1mohZqNaag=' %>
 ```
@@ -90,34 +94,56 @@ Example utilizing `html_options` with a `nonce`:
 Rendered code in the view:
 ```html
 <div id="render_async_18b8a6cd161499117471">
-  <div id="render_async_18b8a6cd161499117471_spinner" class="sk-spinner sk-spinner-double-bounce">
-    <div class="sk-double-bounce1"></div>
-    <div class="sk-double-bounce2"></div>
-  </div>
 </div>
 
 <script nonce="lWaaV6eYicpt+oyOfcShYINsz0b70iR+Q1mohZqNaag=">
 //<![CDATA[
 
     (function($){
-      $.ajax({
-          url: "/users",
-        })
-        .done(function(response, status) {
-          $("#render_async_18b8a6cd161499117471").html(response);
-        })
-        .fail(function(response, status) {
-          $("#render_async_18b8a6cd161499117471").html(response);
-        })
-        .always(function(response, status) {
-          $("#render_async_18b8a6cd161499117471_spinner").hide();
-        });
+      $.ajax({ url: "/users" }).always(function(response) {
+        $("#render_async_18b8a6cd161499117471").replaceWith(response);
+      });
     }(jQuery));
 
 //]]>
 </script>
 ```
 
+### Passing in a placeholder
+
+`render_async` can be called with a block that will act as a placeholder before
+your AJAX call finishes.
+
+Example of passing in a block:
+
+```erb
+<%= render_async users_path do %>
+  <h1>Users are loading...</h1>
+<% end %>
+```
+
+Rendered code in the view:
+```html
+<div id="render_async_14d7ac165d1505993721">
+  <h1>Users are loading...</h1>
+</div>
+
+<script>
+//<![CDATA[
+
+    (function($){
+      $.ajax({ url: "/users" }).always(function(response) {
+        $("#render_async_14d7ac165d1505993721").replaceWith(response);
+      });
+    }(jQuery));
+
+//]]>
+</script>
+```
+
+After AJAX is finished, placeholder will be replaced with the request's
+response.
+
 ## Caching
 
 `render_async` can utilize view fragment caching to avoid extra AJAX calls.

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

@@ -1,15 +1,12 @@
-<div id="<%= container_name %>">
-  <div id="<%= container_name %>_spinner" class="sk-spinner sk-spinner-double-bounce">
-    <div class="sk-double-bounce1"></div>
-    <div class="sk-double-bounce2"></div>
-  </div>
+<div id="<%= container_id %>">
+  <%= placeholder %>
 </div>
 
 <% content_for :render_async do %>
   <%= javascript_tag html_options do %>
     (function($){
-      $.ajax({ url: "<%= path %>"}).always(function(response) {
-        $("#<%= container_name %>").replaceWith(response);
+      $.ajax({ url: "<%= path %>" }).always(function(response) {
+        $("#<%= container_id %>").replaceWith(response);
       });
     }(jQuery));
   <% end %>

data/lib/render_async/version.rb

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

data/lib/render_async/view_helper.rb

@@ -16,12 +16,14 @@ module RenderAsync
       end
     end
 
-    def render_async(path, html_options = {})
-      container_name = "render_async_#{SecureRandom.hex(5)}#{Time.now.to_i}"
+    def render_async(path, html_options = {}, &placeholder)
+      container_id = "render_async_#{SecureRandom.hex(5)}#{Time.now.to_i}"
+      placeholder = capture(&placeholder) if block_given?
 
-      render "render_async/render_async", :container_name => container_name,
-                                          :path => path,
-                                          :html_options => html_options
+      render 'render_async/render_async', container_id: container_id,
+                                          path: path,
+                                          html_options: html_options,
+                                          placeholder: placeholder
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler