progressive_render 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b9a3f8c18f83d1552eb57f92fe03559ff4cb928
-  data.tar.gz: 840b52a7d149e70d980bc1fde05e0f9513b2ab28
+  metadata.gz: 66c3ea0521fead6a74bac5c2684adb2594f37fc8
+  data.tar.gz: f7f2afaba6f1545d4b6510e29cb2829c62df2da6
 SHA512:
-  metadata.gz: f86a82ec6cd7096af2a4eb5f2cae30335c427ebb3e03741c97b31f870df0fa4a3f2c1f7ec02fe3588477cec863e310bb4bd77f548567e2ecac7ce0f8cd0937fb
-  data.tar.gz: 909bc7ba4ae306a1c5e257425c4b3123826b280b03ec2586f17b4c5e7514745f562375ab08e3d9b6507f98e0edc4015734f9dd7b8db5e8c7f4ef77ef825160c5
+  metadata.gz: 1d7b7b5b01e702bdc67e0dd3f6fd6fe5da9078ad3373dfd1efb7ceea7a830f811fd97a675f953aef62b71462f01889fdbceccd96b2d16dd9688cb976ec0cf2f6
+  data.tar.gz: 414339daf49bb4677914d3e3b625e0e6eb0d838c974969ab9d28b8fe4e07794952ac1e3528f1037b43ff4237a42ff0a6f4b0e47d2ce135780b11afb177e81f6a

data/DESIGN.md

@@ -60,53 +60,28 @@ rh.load_path(fragment_name)
 rh.should_render_partial?(fragment_name)
 ```
 
-# RailsBuilder #
-Status: TODO
-
-Takes all necessary context and gives access to the ProgressiveRenderer
-
-## Basic Syntax ##
-```ruby
-rb = RailsBuilder.new(request)
-rb.view_renderer => ProgressiveRenderer
-rb.controller_renderer => ProgressiveRenderer
-```
-
-# ProgresiveRenderer #
-Status: TODO. Currently handled by ProgressiveRender::Controller/View/Helpers
-
-Applies all policies to provide a simple render interface. 
-
-Can we get around the partial_renderer field? It determines if it should render placeholders in place of the view passed into it. 
-
-## Basic Syntax ##
-```ruby
-pr = ProgressiveRenderer.new(request_handler, view_renderer, path_resolver, partial_renderer:bool)
-pr.render(partial_name, &block=nil)
-```
-
-# RailsInstaller #
-Status: TODO. Currently handled by ProgressiveRender
+# Rails Engine #
+Status: Implemented
 
 Installs the view/controller renderer into ActionView/ActionController
 
 ## Basic Syntax ##
 ```ruby
-RailsInstaller.mount_initializer
-# Or?
-RailsInstaller.mount_initializer(app)
+class Engine < ::Rails::Engine
+  # .. installation code ..
+end
 ```
 
-
 # Structure #
+```
 lib/
-  progressive_render.rb (version)
+  progressive_render.rb
   rails/
     rails.rb
-    installer.rb
+    engine.rb
     builder.rb
     view_renderer.rb
     path_resolver.rb
   rack/
     request_handler.rb
-  progressive_renderer.rb
+```

data/README.md

@@ -1,9 +1,11 @@
 # ProgressiveRender [![Gem Version](https://badge.fury.io/rb/progressive_render.svg)](http://badge.fury.io/rb/progressive_render) #
 
-![ProgressiveRender Demo](http://g.recordit.co/NsoKrtutzi.gif) 
+![ProgressiveRender Demo](http://g.recordit.co/WgVCYoUWuh.gif) 
 
 Slow content got you down? Load it later! Use this gem to defer loading of portions of your page until after load. They will be fetched via AJAX and placed on the page when ready.
 
+For a quick start, see [Drifting Ruby #033 - Progressive Render](https://www.driftingruby.com/episodes/progressive-render) based on version 0.3.0. Note the controller changes are no longer required in 0.4.0.
+
 ## Why? ##
 You wrote all your code and it got a bit slow with all that production data. Or perhaps you have less important content that you want on the view, but it's not worth blocking the entire page for. With this gem there's almost no developer work to make this happen. All requests go through your controller and your normal filters so you're permissions are respected. The only added overhead is an additional round-trip for each partial and duplicated rendering of the main view. 
 
@@ -44,18 +46,9 @@ Wrap slow content in your view with a call to `progressive_render`:
 <% end %>
 ```
 
-In the controller action, end it with:
-
-```ruby
-def action
-    # your code here
-    progressive_render
-end
-```
-
 ## Example Application ##
 
-For a more indepth example, see the test application located within this repository in `spec/dummy`
+For a more in-depth example, see the test application located within this repository in `spec/dummy`
 
 ## Customizing the Placeholder ##
 

data/gemfiles/rails_4_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    progressive_render (0.3.0)
+    progressive_render (0.4.1)
       coffee-rails
       jquery-rails
       nokogiri
@@ -51,9 +51,9 @@ GEM
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
-    coffee-rails (4.1.1)
+    coffee-rails (4.2.1)
       coffee-script (>= 2.2.0)
-      railties (>= 4.0.0, < 5.1.x)
+      railties (>= 4.0.0, < 5.2.x)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -124,8 +124,8 @@ GEM
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
     sass (3.4.22)
-    sass-rails (5.0.4)
-      railties (>= 4.0.0, < 5.0)
+    sass-rails (5.0.5)
+      railties (>= 4.0.0, < 6)
       sass (~> 3.1)
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)

data/gemfiles/rails_4_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    progressive_render (0.3.0)
+    progressive_render (0.4.1)
       coffee-rails
       jquery-rails
       nokogiri
@@ -60,9 +60,9 @@ GEM
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
-    coffee-rails (4.1.1)
+    coffee-rails (4.2.1)
       coffee-script (>= 2.2.0)
-      railties (>= 4.0.0, < 5.1.x)
+      railties (>= 4.0.0, < 5.2.x)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -147,8 +147,8 @@ GEM
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
     sass (3.4.22)
-    sass-rails (5.0.4)
-      railties (>= 4.0.0, < 5.0)
+    sass-rails (5.0.5)
+      railties (>= 4.0.0, < 6)
       sass (~> 3.1)
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)

data/gemfiles/rails_5_0_0_beta4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    progressive_render (0.3.0)
+    progressive_render (0.4.1)
       coffee-rails
       jquery-rails
       nokogiri
@@ -61,9 +61,9 @@ GEM
     codeclimate-test-reporter (0.5.1)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
-    coffee-rails (4.1.1)
+    coffee-rails (4.2.1)
       coffee-script (>= 2.2.0)
-      railties (>= 4.0.0, < 5.1.x)
+      railties (>= 4.0.0, < 5.2.x)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -155,8 +155,8 @@ GEM
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
     sass (3.4.22)
-    sass-rails (5.0.4)
-      railties (>= 4.0.0, < 5.0)
+    sass-rails (5.0.5)
+      railties (>= 4.0.0, < 6)
       sass (~> 3.1)
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)

data/lib/progressive_render/rails/controller.rb

@@ -0,0 +1,54 @@
+require 'progressive_render/rails/helpers'
+
+module ProgressiveRender
+module Rails
+
+module Controller
+  include Helpers
+
+  def progressive_render(template=nil)
+    logger.warn "DEPRECATED: calling 'progressive_render' directly in the controller is deprecated and will be removed in future versions. It is no longer necessary to explicitly call the render method."
+    render template
+  end
+
+  def resolve_path(template)
+    tc = Rails::PathResolver::TemplateContext.new
+    tc.type       = :controller
+    tc.controller = request.params["controller"]
+    tc.action     = request.params["action"]
+
+    pr = Rails::PathResolver.new(tc)
+
+    pr.path_for(template)
+  end
+
+  def render(options = nil, extra_options = {}, &block) 
+    # Fall back to the ActionView renderer if we're on the main page load
+    # OR we are being called from inside our own code (in_progressive_render?)
+    if progressive_request.is_main_load? || in_progressive_render?
+      super
+    else
+      in_progressive_render do
+        # To preserve legacy behavior pass options through to resolve_path if it's a string
+        # ActiveRecord more properly handles the path so use that when possible.
+        template = options if options.is_a? String
+        progressive_renderer.render_fragment resolve_path(template), progressive_request.fragment_name
+      end
+    end
+  end
+
+  def in_progressive_render?
+    @in_progressive_render
+  end
+
+  # To prevent the render call from reentrancy we need to remember if we're in our own render path.
+  # Our rendering code calls 'render' to access the real view renderer so we need a way to fall back to it.
+  def in_progressive_render(&block)
+    @in_progressive_render = true
+    block.call
+    @in_progressive_render = false
+  end
+end
+
+end
+end

data/lib/progressive_render/rails/engine.rb

@@ -0,0 +1,21 @@
+module ProgressiveRender
+module Rails
+
+class Engine < ::Rails::Engine
+	initializer "progressive_render.assets.precompile" do |app|
+		app.config.assets.precompile += %w( progressive_render.gif progressive_render.js.coffee progressive_render.css.scss )
+	end
+
+	initializer "progressive_render.install" do
+		ActionController::Base.class_eval do
+			prepend ProgressiveRender::Rails::Controller
+		end
+
+		ActionView::Base.class_eval do
+			prepend ProgressiveRender::Rails::View
+		end
+	end
+end
+
+end
+end

data/lib/progressive_render/rails/helpers.rb

@@ -0,0 +1,14 @@
+module ProgressiveRender
+module Rails
+
+module Helpers
+	def progressive_request
+		@rh ||= Rack::RequestHandler.new(request)
+	end
+	def progressive_renderer
+		Rails::ViewRenderer.new(self)
+	end
+end
+
+end
+end

data/lib/progressive_render/rails/view.rb

@@ -0,0 +1,39 @@
+require 'progressive_render/rails/helpers'
+
+module ProgressiveRender
+module Rails
+
+module View
+	include Helpers
+	
+	def progressive_render(deprecated_fragment_name = nil, placeholder: 'progressive_render/placeholder', cache_keys: nil, &content)
+		fragment_name = fragment_name_iterator.next!
+
+		if deprecated_fragment_name
+			logger.warn "DEPRECATED (progressive_render gem): Literal fragment names are deprecated and will be removed in v1.0. The fragment name (#{deprecated_fragment_name}) will be ignored."
+		end
+
+		progressive_render_content(fragment_name, progressive_request.is_main_load?) do
+			if progressive_request.is_main_load?
+				progressive_renderer.render_partial placeholder
+			elsif progressive_request.should_render_fragment?(fragment_name)
+				content.call
+			end
+		end
+	end
+
+	def progressive_render_content(fragment_name, placeholder=true)
+		content_tag(:div, id: "#{fragment_name}_progressive_render", 
+					data: {progressive_render_placeholder: placeholder, 
+								 progressive_render_path: progressive_request.load_path(fragment_name)}.select {|k,v| !v.nil? }) do
+			yield
+		end
+	end
+
+	def fragment_name_iterator
+		@fni ||= FragmentNameIterator.new
+	end
+end
+
+end
+end

data/lib/progressive_render/rails.rb

@@ -1,5 +1,10 @@
 require 'progressive_render/rails/path_resolver'
 require 'progressive_render/rails/view_renderer'
+require 'progressive_render/rails/engine'
+
+require 'progressive_render/rails/helpers'
+require 'progressive_render/rails/view'
+require 'progressive_render/rails/controller'
 
 module ProgressiveRender
 	module Rails

data/lib/progressive_render/version.rb

@@ -1,3 +1,3 @@
 module ProgressiveRender
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/progressive_render.rb

@@ -1,32 +1,11 @@
-require 'progressive_render/version'
-require 'progressive_render/controller'
-require 'progressive_render/view'
-
 require 'progressive_render/rack'
-require 'progressive_render/rails'
 
 require 'progressive_render/fragment_name_iterator'
 
 module ProgressiveRender
-  if defined?(::Rails) and Gem::Requirement.new('>= 3.1').satisfied_by?(Gem::Version.new ::Rails.version)
-    module Rails
-      class Engine < ::Rails::Engine
-        initializer "progressive_render.assets.precompile" do |app|
-          app.config.assets.precompile += %w( progressive_render.gif progressive_render.js.coffee progressive_render.css.scss )
-        end
-
-        initializer "progressive_render.install" do
-          ActionController::Base.class_eval do
-            include ProgressiveRender::Controller
-          end
-
-          ActionView::Base.class_eval do
-            include ProgressiveRender::View
-          end
-        end
-      end
-    end
-  else
-    puts "WARNING: ProgressiveRender has not been installed due to missing dependencies"
-  end
-end
+	if defined?(::Rails) and Gem::Requirement.new('>= 3.1').satisfied_by?(Gem::Version.new ::Rails.version)
+		require 'progressive_render/rails'
+	else
+		logger.warn "WARNING: ProgressiveRender has not been installed due to missing dependencies"
+	end
+end

data/vendor/assets/javascripts/progressive_render.js.coffee

@@ -11,9 +11,8 @@ setup_listener = ->
 load_missing_content = ->
   $('[data-progressive-render-placeholder=true]').each ->
     $this = $(this)
-    # Don't re-process div's we've already seen
-    return if $this.data('progressive-render-setup')
-    $this.data('progressive-render-setup', true)
+    # Remove the designation on this partial from the DOM so we don't attempt to re-load it later.
+    $this.attr('data-progressive-render-placeholder', false)
 
     # Start the load
     $.ajax url: $this.data('progressive-render-path'), cache: false, success: (response) -> 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progressive_render
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jeff Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -249,16 +249,17 @@ files:
 - gemfiles/rails_5_0_0_beta4.gemfile
 - gemfiles/rails_5_0_0_beta4.gemfile.lock
 - lib/progressive_render.rb
-- lib/progressive_render/controller.rb
 - lib/progressive_render/fragment_name_iterator.rb
-- lib/progressive_render/helpers.rb
 - lib/progressive_render/rack.rb
 - lib/progressive_render/rack/request_handler.rb
 - lib/progressive_render/rails.rb
+- lib/progressive_render/rails/controller.rb
+- lib/progressive_render/rails/engine.rb
+- lib/progressive_render/rails/helpers.rb
 - lib/progressive_render/rails/path_resolver.rb
+- lib/progressive_render/rails/view.rb
 - lib/progressive_render/rails/view_renderer.rb
 - lib/progressive_render/version.rb
-- lib/progressive_render/view.rb
 - progressive_load.gemspec
 - vendor/assets/images/progressive_render.gif
 - vendor/assets/javascripts/progressive_render.js.coffee
@@ -283,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Progressively load static or dynamic content on page load

data/lib/progressive_render/controller.rb

@@ -1,26 +0,0 @@
-require 'progressive_render/helpers'
-
-module ProgressiveRender
-  module Controller
-    include Helpers
-
-    def progressive_render(template=nil)
-      if progressive_request.is_main_load?
-        progressive_renderer.render_view resolve_path(template)
-      else
-        progressive_renderer.render_fragment resolve_path(template), progressive_request.fragment_name 
-      end
-    end
-
-    def resolve_path(template)
-      tc = Rails::PathResolver::TemplateContext.new
-      tc.type       = :controller
-      tc.controller = request.params["controller"]
-      tc.action     = request.params["action"]
-
-      pr = Rails::PathResolver.new(tc)
-
-      pr.path_for(template)
-    end
-  end
-end

data/lib/progressive_render/helpers.rb

@@ -1,10 +0,0 @@
-module ProgressiveRender
-  module Helpers
-    def progressive_request
-      @rh ||= Rack::RequestHandler.new(request)
-    end
-    def progressive_renderer
-      Rails::ViewRenderer.new(self)
-    end
-  end
-end

data/lib/progressive_render/view.rb

@@ -1,35 +0,0 @@
-require 'progressive_render'
-
-module ProgressiveRender
-  module View
-    include Helpers
-    
-    def progressive_render(deprecated_fragment_name = nil, placeholder: 'progressive_render/placeholder', cache_keys: nil, &content)
-      fragment_name = fragment_name_iterator.next!
-
-      if deprecated_fragment_name
-        logger.warn "DEPRECATED (progressive_render gem): Literal fragment names are dperecated and will be removed in v1.0. The fragment name (#{deprecated_fragment_name}) will be ignored."
-      end
-
-      progressive_render_content(fragment_name, progressive_request.is_main_load?) do
-        if progressive_request.is_main_load?
-          progressive_renderer.render_partial placeholder
-        elsif progressive_request.should_render_fragment?(fragment_name)
-          content.call
-        end
-      end
-    end
-
-    def progressive_render_content(fragment_name, placeholder=true)
-      content_tag(:div, id: "#{fragment_name}_progressive_render", 
-            data: {progressive_render_placeholder: placeholder, 
-                   progressive_render_path: progressive_request.load_path(fragment_name)}) do
-        yield
-      end
-    end
-
-    def fragment_name_iterator
-      @fni ||= FragmentNameIterator.new
-    end
-  end
-end