render_async 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aec789eda10aa5db3c538756631ee0e6963c6f5e
-  data.tar.gz: 424668e8679890bbf1b8d37bf4ec1e56a7c7cbaf
+  metadata.gz: 34364781d19ea77161a9be8861be690efc034fd1
+  data.tar.gz: 2cc3906d7c0c680f663694dc9d9224daf0091fc4
 SHA512:
-  metadata.gz: 6cd574849e185137bf16f02b7502ea4f3d0d18deedbf383b289e8f5ee0455c49d55a077f298b01a4338730e5198dda222dc2fbdb03ebe99964ba615b7763c555
-  data.tar.gz: 508546ce17b2ffad8e730c1050dc484b266dfb894318c5c8b9693e8e48a53e3ff42555970840d1bec4ade0dcc6b029ca5349437d51d1d8f8f575551c213f4858
+  metadata.gz: 663f85b5338e9348745f4b515aa630b0e035fa7e598a6adfa7b7d8848e8fa25f20eec8eb1d65120f5885b3bc09314fa074cd617b4f002f028178b059757a1720
+  data.tar.gz: e5e3b70a41ae41946651c20204b7414bde2073cc70803fd8b1a1e46ab3a3766d0148d4267bc64f8d9d289bb289a69be4448b72b34abbb24a865efaad7be54ab1

data/README.md

@@ -164,6 +164,54 @@ Rendered code in the view:
 After AJAX is finished, placeholder will be replaced with the request's
 response.
 
+### Passing in an event name
+
+`render_async` can receive `:event_name` option which will emit Javascript
+event after it's done with fetching and rendering request content to HTML.
+
+This can be useful to have if you want to add some Javascript functionality
+after your partial is loaded through `render_async`.
+
+Example of passing it to `render_async`:
+```erb
+<%= render_async users_path, :event_name => "users-loaded" %>
+```
+
+Rendered code in view:
+```html
+<div id="render_async_04229e7abe1507987376">
+</div>
+
+<script>
+//<![CDATA[
+  (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_04229e7abe1507987376").outerHTML = request.responseText;
+
+        document.dispatchEvent(new Event("users-loaded"));
+      }
+    };
+
+    request.send();
+  })();
+//]]>
+</script>
+```
+
+Then, in your JS, you could do something like this:
+```javascript
+document.addEventListener("users-loaded", function() {
+  console.log("Users have loaded!");
+});
+```
+
 ## Caching
 
 `render_async` can utilize view fragment caching to avoid extra AJAX calls.
@@ -210,12 +258,6 @@ 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 install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/renderedtext/render_async.

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

@@ -15,6 +15,10 @@
       request.onload = function() {
         if (request.status >= SUCCESS && request.status < ERROR) {
           document.getElementById("<%= container_id %>").outerHTML = request.responseText;
+
+          <% if event_name.present? %>
+            document.dispatchEvent(new Event("<%= event_name %>"));
+          <% end %>
         }
       };
 

data/lib/render_async/version.rb

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

data/lib/render_async/view_helper.rb

@@ -7,22 +7,25 @@ module RenderAsync
       "render_async_#{path}"
     end
 
-    def render_async_cache(path, html_options = {})
+    def render_async_cache(path, options = {})
       cached_view = Rails.cache.read("views/#{render_async_cache_key(path)}")
+
       if cached_view.present?
         render :html => cached_view.html_safe
       else
-        render_async(path, html_options)
+        render_async(path, options)
       end
     end
 
-    def render_async(path, html_options = {}, &placeholder)
+    def render_async(path, options = {}, &placeholder)
       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,
                                           path: path,
-                                          html_options: html_options,
+                                          html_options: options,
+                                          event_name: event_name,
                                           placeholder: placeholder
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kasper Grubbe