render_async 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f1e55f1d2d9bd896fcb28007fb3bfe42752d4d90
-  data.tar.gz: ac66f3e90a93a3952b0b5f690ab1d79e85b2284c
+SHA256:
+  metadata.gz: c7348b088d336af949c92c6132a741fac0d1ccdda790d216fcd4a8bfba852dc0
+  data.tar.gz: 0ad8ed64d193321f04d6c623e4ed18992cd5638f0302a8736242c135dabb17ef
 SHA512:
-  metadata.gz: 43ffe5cf4db879ec44baf27f68435ef275206ce725085ae6c6f1f139c44fcafd215e41b79ce0b44c471698a4b2cf21353e6ae9f07bd95620321f121551d0c49b
-  data.tar.gz: 089b856889e18dd218372284ee4cfe86dd8aa08260ad55b58e39334a694e981de7c407a237a3686bbe69c71109bbc36c29bfb90163404b0d7efeaefa1db34389
+  metadata.gz: 68b8ebb7fa1bc91b5dcb51f7f86bde67fa404cb4159f73e98c1d75bb54ee9775f2cf13ef5373d2c1d8750ff9130dfa28fab3a85bffe1649eb529becba0006f32
+  data.tar.gz: 3809facb7cb728243aaed8d215dd29607c88baec7781b2df109cc7b91223d2fc919903db3a72c6b5ba2222739323964785e7cb34c0dff8b9e841113756095e2c

data/.all-contributorsrc

@@ -106,6 +106,24 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "richardvenneman",
+      "name": "Richard Venneman",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/75705?v=4",
+      "profile": "https://www.cityspotters.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "filipewl",
+      "name": "Filipe W. Lima",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/381395?v=4",
+      "profile": "https://github.com/filipewl",
+      "contributions": [
+        "doc"
+      ]
     }
   ]
 }

data/README.md

@@ -1,5 +1,5 @@
 [![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-10-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-12-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)
@@ -12,7 +12,7 @@
 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
+through adding JavaScript code that does AJAX request to your controller which
 then renders your partial into a Rails view.
 
 Workflow:
@@ -22,15 +22,15 @@ Workflow:
 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
+JavaScript is injected into `<%= content_for :render_async %>` so you choose
 where to put it.
 
 ## Installation
-
+S
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'render_async'
+gem 'Sender_async'
 ```
 
 And then execute:
@@ -65,7 +65,7 @@ And then execute:
     </div>
     ```
 
-5. Add `content_for` in your base view file (e.g. `app/views/layouts/application.html.erb`):
+5. Add `content_for` in your base view file in the body part (e.g. `app/views/layouts/application.html.erb`):
     ```erb
     <%= content_for :render_async %>
     ```
@@ -80,6 +80,7 @@ Advanced usage includes information on different options, such as:
   - [Passing in an event name](#passing-in-an-event-name)
   - [Caching](#caching)
   - [Using with Turbolinks](#using-with-turbolinks)
+  - [Using with respond_to and JS format](#using-with-respond_to-and-js-format)
   - [Nested Async Renders](#nested-async-renders)
 
 ### Passing in HTML options
@@ -159,10 +160,10 @@ response.
 
 ### Passing in an event name
 
-`render_async` can receive `:event_name` option which will emit Javascript
+`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
+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`:
@@ -228,6 +229,37 @@ To resolve, tell turbolinks to reload your `render_async` call as follows:
 <%= render_async events_path, 'data-turbolinks-track': 'reload' %>
 ```
 
+Make sure to put `<%= content_for :render_async %>` in your base view file in
+the `<head>` and not the `<body>`.
+
+### Using with respond_to and JS format
+
+If you need to restrict the action to only respond to AJAX requests, you'll
+likely wrap it inside `respond_to`/`format.js` blocks like this:
+
+```ruby
+def comment_stats
+  respond_to do |format|
+    format.js do
+      @stats = Comment.get_stats
+
+      render :partial => "comment_stats"
+    end
+  end
+end
+```
+
+When you do this, Rails will sometime set the response's `Content-Type` header
+to `text/javascript`. This causes the partial not to be rendered in the HTML.
+This usually happens when there's browser caching.
+
+You can get around it by specifying the content type to `text/html` in the
+render call:
+
+```ruby
+render :partial => "comment_stats", :content_type => 'text/html'
+```
+
 ### Nested Async Renders
 
 It is possible to nest async templates within other async templates. When doing
@@ -276,7 +308,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
 <!-- 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") [💡](#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://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") |
+| [<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") | [<img src="https://avatars1.githubusercontent.com/u/75705?v=4" width="100px;"/><br /><sub>Richard Venneman</sub>](https://www.cityspotters.com)<br />[📖](https://github.com/renderedtext/render_async/commits?author=richardvenneman "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/381395?v=4" width="100px;"/><br /><sub>Filipe W. Lima</sub>](https://github.com/filipewl)<br />[📖](https://github.com/renderedtext/render_async/commits?author=filipewl "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

@@ -8,6 +8,9 @@
                formats: [:js],
                locals:  { container_id: container_id,
                           path: path,
-                          event_name: event_name } %>
+                          method: method,
+                          data: data,
+                          event_name: event_name,
+                          headers: headers } %>
   <% end %>
 <% end %>

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

@@ -1,7 +1,17 @@
 if (window.jQuery) {
   (function($) {
     $(document).ready(function() {
-      $.ajax({ url: "<%= path.html_safe %>" }).always(function(response) {
+      var headers = <%= headers.to_json.html_safe %>;
+      var csrfTokenElement = document.querySelector('meta[name="csrf-token"]')
+      if (csrfTokenElement)
+        headers['X-CSRF-Token'] = csrfTokenElement.content
+
+      $.ajax({
+        url: '<%= path.html_safe %>',
+        method: '<%= method %>',
+        data: "<%= escape_javascript(data.to_s.html_safe) %>",
+        headers: headers
+      }).always(function(response) {
         $("#<%= container_id %>").replaceWith(response);
 
         <% if event_name.present? %>
@@ -18,11 +28,20 @@ if (window.jQuery) {
       var SUCCESS = 200;
       var ERROR = 400;
 
-      request.open("GET", "<%= path.html_safe %>", asyncRequest);
+      request.open('<%= method %>', '<%= path.html_safe %>', asyncRequest);
+
+      var headers = <%= headers.to_json.html_safe %>;
+      var csrfTokenElement = document.querySelector('meta[name="csrf-token"]')
+      if (csrfTokenElement)
+        headers['X-CSRF-Token'] = csrfTokenElement.content
+
+      Object.keys(headers).map(function(key) {
+        request.setRequestHeader(key, headers[key]);
+      });
 
       request.onload = function() {
         if (request.status >= SUCCESS && request.status < ERROR) {
-          var container = document.getElementById("<%= container_id %>");
+          var container = document.getElementById('<%= container_id %>');
           container.outerHTML = request.response;
 
           <% if event_name.present? %>
@@ -31,7 +50,8 @@ if (window.jQuery) {
         }
       };
 
-      request.send();
+      var body = "<%= escape_javascript(data.to_s.html_safe) %>";
+      request.send(body);
     });
   })();
 }

data/lib/render_async/version.rb

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

data/lib/render_async/view_helper.rb

@@ -18,17 +18,23 @@ module RenderAsync
     end
 
     def render_async(path, options = {}, &placeholder)
-      html_element_name = options.delete(:html_element_name) || "div"
+      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?
+      method = options.delete(:method) || 'GET'
+      data = options.delete(:data)
+      headers = options.delete(:headers) || {}
 
       render 'render_async/render_async', html_element_name: html_element_name,
                                           container_id: container_id,
                                           path: path,
                                           html_options: options,
                                           event_name: event_name,
-                                          placeholder: placeholder
+                                          placeholder: placeholder,
+                                          method: method,
+                                          data: data,
+                                          headers: headers
     end
 
   end

data/render_async.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nikolaseap@gmail.com"]
 
   spec.summary       = "Render parts of the page asynchronously with AJAX"
-  spec.description   = "Load parts of your page through simple Javascript and Rails pipeline"
+  spec.description   = "Load parts of your page through simple JavaScript and Rails pipeline"
   spec.homepage      = "https://github.com/renderedtext/render_async"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.8
-description: Load parts of your page through simple Javascript and Rails pipeline
+description: Load parts of your page through simple JavaScript and Rails pipeline
 email:
 - nikolaseap@gmail.com
 executables: []
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Render parts of the page asynchronously with AJAX