render-later 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ed24ef6ef278f6b32265a03b669da4dfd2d89a5
-  data.tar.gz: 679cb4db160e2f287656ccfe4ef1b8e05484af3f
+  metadata.gz: e1124bb4e36a64975fbdc6b79b35bbccf1afaf03
+  data.tar.gz: b8d83484ce27bb6a415238ecc88069e126bad8d6
 SHA512:
-  metadata.gz: ce8efe885bf50f0cb29b4070d739f812a1049109567198b39fd4f90e76d80def1b7c2771c5ea8fe658051673ad67c8f3af5cc61d46b883d6ac6cc06b79fcb8ec
-  data.tar.gz: 6db85e49c804372d9e887e288ce9390075410e2123e7e6089f57b128ac389f87fc5a86a4f5a848fe9bd5f177d15554787eb853369127b423de6c35df6de94af4
+  metadata.gz: 860835d8c1a20743fd278850de9a5f66cb3d9131d8829a41a3eb6dd43611d98f4c4586ef17b8d792da564344db65b2fc7eb842622c7a8b4b5512a540ae9d513d
+  data.tar.gz: 63718790b5cac1da165f5e22be2960ea41370302d65cfd46f7b416aeb42b3a73a557c1299fa26a74350faba3cc4ef11244b959d6e65c7e66480e7d08038dc0ec

data/README.md

@@ -84,8 +84,25 @@ Phusion Passenger | ✔️         |
 Unicorn           | ✔️         | _with `tcp_nopush: false`_
 puma              | ✔️         |
 WEBrick           | ❌         | _default for `rails s`_
+Thin              | ❌         |
 
-To try it in development I recommend simply adding `gem 'puma'` to your `Gemfile` and `rails s` will use it. Though it's totally fine to work with a server which doesn't support streaming, you just won't benefit from the speed.
+To try it in development, I recommend adding `gem 'unicorn-rails'` to your `Gemfile`'s development group and use `UNICORN_WORKERS=4 rails s` to start it. We need multiple processes in development to avoid blocking CSS requests during the page load. It's totally fine to develop with a single process or a server which doesn't support streaming, you just won't see the effects of the gem.
+
+### gzip
+
+Unforunately I counldn't manage to make streaming works with gzip compression (provided by default in nginx), which means that if you're using nginx to compress your pages (and you should) this won't work, the page will be rendered all at once as before. I haven't investigated much but it seems to be because nginx need to have the whole body to compress it all at once and then start streaming the compressed body (but it's too late).
+
+So the only workaround I have it to disable gzip compression for pages you want to stream, and no, it won't hurt performance that much. Sending 50kb html instead 6kb gzip is fine if it saves 3sec in render time.
+
+Example:
+```
+location / {
+  if ( $request_uri ~ ^/slow$ ) {
+    gzip off;
+  }
+  ...
+}
+```
 
 #### Template Engine
 Like for web servers, some template engine in Rails doesn't support streaming and requires to generate the entire page before sending it on the wire. You will need to avoid them at least for the layout page which will contain the `render_now` statement.

data/app/helpers/render_later/view_helper.rb

@@ -26,6 +26,7 @@ module RenderLater
         concat content_tag('script', raw("rl_insert('rl-#{key}', '#{j capture(&block)}');\n"))
       end
       nil
+    rescue Errno::EPIPE
     end
 
     private
@@ -38,7 +39,11 @@ module RenderLater
     end
 
     def deferred_objects
-      request.instance_variable_get(:@deferred_objects) || {}
+      if request.instance_variable_defined?(:@deferred_objects)
+        request.instance_variable_get(:@deferred_objects)
+      else
+        {}
+      end
     end
   end
 end

data/lib/render-later/version.rb

@@ -1,3 +1,3 @@
 module RenderLater
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/render-later.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rails", ">= 4.0"
+  spec.add_development_dependency "rails", "~> 4.0"
   spec.add_development_dependency "puma"
   spec.add_development_dependency "poltergeist"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render-later
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Adrien Jarthon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-16 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -139,3 +139,4 @@ signing_key:
 specification_version: 4
 summary: Defer rendering of slow parts to the end of the page
 test_files: []
+has_rdoc: