progressive_render 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66c3ea0521fead6a74bac5c2684adb2594f37fc8
-  data.tar.gz: f7f2afaba6f1545d4b6510e29cb2829c62df2da6
+  metadata.gz: c0055d64a0089eea6faf3c3c0151b1003b55e90d
+  data.tar.gz: b8035bf632af47521f3e31755f7e08deb172f0e7
 SHA512:
-  metadata.gz: 1d7b7b5b01e702bdc67e0dd3f6fd6fe5da9078ad3373dfd1efb7ceea7a830f811fd97a675f953aef62b71462f01889fdbceccd96b2d16dd9688cb976ec0cf2f6
-  data.tar.gz: 414339daf49bb4677914d3e3b625e0e6eb0d838c974969ab9d28b8fe4e07794952ac1e3528f1037b43ff4237a42ff0a6f4b0e47d2ce135780b11afb177e81f6a
+  metadata.gz: 6a07fba3ab6163da94523596947685023de5785114c2b714d8b29071c5de78e1d2cf4c565dabcbdf7be35d5c7950c9a1a4ffc03ee890dca997a496c0324ec298
+  data.tar.gz: 45add62929d21577da019f699e0fe3906f80ec1929c4af5486f7c7c09aeeb8a4bfc7de965c58552f6649f6bbbb54ef185a9c3903330ccd7879f8d62a8ee453a5

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120
+
+AllCops:
+  Exclude:
+    - spec/dummy/bin/rake
+    - spec/dummy/bin/rails
+    - spec/dummy/bin/spring
+    - gemfiles/vendor/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-07-31 14:02:10 -0700 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/controller_request_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/controller_request_spec.rb'

data/.travis.yml

@@ -4,6 +4,11 @@ rvm:
   - 2.2.5
   - 2.3.1
   - ruby-head
+# Suppress the container warning
+sudo: false
+
+# Cache dependencies
+cache: bundler
 
 before_install: gem install bundler -v 1.10.3
 

data/DESIGN.md

@@ -54,7 +54,7 @@ Parses the request object to determine if this is the main load of the app and i
 ## Basic Syntax ##
 ```ruby
 rh = RequestHandler.new(request)
-rh.is_main_load?
+rh.main_load?
 rh.fragment_name
 rh.load_path(fragment_name)
 rh.should_render_partial?(fragment_name)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Jeff Johnson
+Copyright (c) 2015, 2016 Jeff Johnson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # ProgressiveRender [![Gem Version](https://badge.fury.io/rb/progressive_render.svg)](http://badge.fury.io/rb/progressive_render) #
 
-![ProgressiveRender Demo](http://g.recordit.co/WgVCYoUWuh.gif) 
+![ProgressiveRender Demo](http://i.imgur.com/J9RtbDc.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.
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: %w(rubocop spec)

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "progressive_render"
+require 'bundler/setup'
+require 'progressive_render'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "progressive_render"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bump_version.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+#
+# Bump the gem version
+# Pass in 'patch, minor, major' to specify what to update. Default is patch.
+#
+# This is needed to ensure all the Gemfile.locks are up to date with the
+# new version. Otherwise any CI builds will fail.
+#
+
+gem install gem-release
+gem bump --version ${1:-patch}
+cd spec/dummy
+bundle install
+cd ../../
+appraisal install
+git add spec/dummy/Gemfile.lock
+git add gemfiles/*.lock
+git commit -am "Bumping collateral for new gem version"
+gem release --tag

data/gemfiles/rails_4_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    progressive_render (0.4.1)
+    progressive_render (0.4.3)
       coffee-rails
       jquery-rails
       nokogiri
@@ -45,6 +45,7 @@ GEM
       rake
       thor (>= 0.14.0)
     arel (5.0.1.20140414130214)
+    ast (2.3.0)
     builder (3.2.2)
     byebug (5.0.0)
       columnize (= 0.9.0)
@@ -76,6 +77,9 @@ GEM
     minitest (5.8.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -101,6 +105,7 @@ GEM
       activesupport (= 4.1.13)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
     rake (10.4.2)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
@@ -123,6 +128,13 @@ GEM
       rspec-mocks (~> 3.3.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     sass (3.4.22)
     sass-rails (5.0.5)
       railties (>= 4.0.0, < 6)
@@ -150,6 +162,7 @@ GEM
       thread_safe (~> 0.1)
     uglifier (3.0.0)
       execjs (>= 0.3.0, < 3)
+    unicode-display_width (1.1.0)
 
 PLATFORMS
   ruby
@@ -165,6 +178,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec
   rspec-rails
+  rubocop
   sqlite3
 
 BUNDLED WITH

data/gemfiles/rails_4_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    progressive_render (0.4.1)
+    progressive_render (0.4.3)
       coffee-rails
       jquery-rails
       nokogiri
@@ -54,6 +54,7 @@ GEM
       rake
       thor (>= 0.14.0)
     arel (6.0.3)
+    ast (2.3.0)
     builder (3.2.2)
     byebug (5.0.0)
       columnize (= 0.9.0)
@@ -90,6 +91,9 @@ GEM
     minitest (5.8.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -124,6 +128,7 @@ GEM
       activesupport (= 4.2.4)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
     rake (10.4.2)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
@@ -146,6 +151,13 @@ GEM
       rspec-mocks (~> 3.3.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     sass (3.4.22)
     sass-rails (5.0.5)
       railties (>= 4.0.0, < 6)
@@ -173,6 +185,7 @@ GEM
       thread_safe (~> 0.1)
     uglifier (3.0.0)
       execjs (>= 0.3.0, < 3)
+    unicode-display_width (1.1.0)
 
 PLATFORMS
   ruby
@@ -188,6 +201,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec
   rspec-rails
+  rubocop
   sqlite3
 
 BUNDLED WITH

data/gemfiles/rails_5_0_0_beta4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    progressive_render (0.4.1)
+    progressive_render (0.4.3)
       coffee-rails
       jquery-rails
       nokogiri
@@ -56,6 +56,7 @@ GEM
       rake
       thor (>= 0.14.0)
     arel (7.0.0)
+    ast (2.3.0)
     builder (3.2.2)
     byebug (9.0.5)
     codeclimate-test-reporter (0.5.1)
@@ -95,7 +96,10 @@ GEM
     nokogiri (1.6.8)
       mini_portile2 (~> 2.1.0)
       pkg-config (~> 1.1.7)
+    parser (2.3.1.2)
+      ast (~> 2.2)
     pkg-config (1.1.7)
+    powerpack (0.1.1)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -133,6 +137,7 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
     rake (10.5.0)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
@@ -154,6 +159,13 @@ GEM
       rspec-mocks (~> 3.1.0)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     sass (3.4.22)
     sass-rails (5.0.5)
       railties (>= 4.0.0, < 6)
@@ -182,6 +194,7 @@ GEM
       thread_safe (~> 0.1)
     uglifier (3.0.0)
       execjs (>= 0.3.0, < 3)
+    unicode-display_width (1.1.0)
     websocket-driver (0.6.4)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
@@ -200,6 +213,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec
   rspec-rails
+  rubocop
   sqlite3
 
 BUNDLED WITH

data/lib/progressive_render/fragment_name_iterator.rb

@@ -1,15 +1,17 @@
 module ProgressiveRender
+  # Generates a prefix for a given progressive_render section in a stable manner.
+  # This way on each load we assign the outer most progressive_render block with
+  # the same name. Nested progressive_render blocks are not supported, this approach
+  # may need to be re-evaluated for that use case.
+  class FragmentNameIterator
+    def initialize
+      @current = 0
+    end
 
-class FragmentNameIterator
-  def initialize
-    @current = 0
-  end
-
-  def next!
-    @current += 1
+    def next!
+      @current += 1
 
-    "#{@current}"
+      @current.to_s
+    end
   end
 end
-
-end

data/lib/progressive_render/rack/request_handler.rb

@@ -1,35 +1,37 @@
 require 'uri'
 
 module ProgressiveRender
-	module Rack
-		class RequestHandler
-			FRAGMENT_KEY = "load_partial"
-
-			def initialize(_request)
-				@request = _request
-			end
-
-			def is_main_load?
-				fragment_name == nil || fragment_name == ""
-			end
-
-			def fragment_name
-				@request.GET[FRAGMENT_KEY]
-			end
-
-			def should_render_fragment?(_fragment_name)
-				!is_main_load? && fragment_name == _fragment_name
-			end
-
-			def load_path(fragment_name)
-				return nil if !is_main_load?
-
-				# Ensure we get a fresh copy of the request and aren't modifying it
-				query = @request.GET.clone
-				query[FRAGMENT_KEY] = fragment_name
-
-				URI::HTTP.build(path: @request.path, query: URI.encode_www_form(query)).request_uri
-			end
-		end
-	end
-end
+  module Rack
+    # Wraps a given rack request to determine what sort of request we're dealing with
+    # and what specific fragment the request is for when it's a progressive request.
+    class RequestHandler
+      FRAGMENT_KEY = 'load_partial'.freeze
+
+      def initialize(request)
+        @request = request
+      end
+
+      def main_load?
+        fragment_name.nil? || fragment_name == ''
+      end
+
+      def fragment_name
+        @request.GET[FRAGMENT_KEY]
+      end
+
+      def should_render_fragment?(user_fragment_name)
+        !main_load? && fragment_name == user_fragment_name
+      end
+
+      def load_path(fragment_name)
+        return nil unless main_load?
+
+        # Ensure we get a fresh copy of the request and aren't modifying it
+        query = @request.GET.clone
+        query[FRAGMENT_KEY] = fragment_name
+
+        URI::HTTP.build(path: @request.path, query: URI.encode_www_form(query)).request_uri
+      end
+    end
+  end
+end

data/lib/progressive_render/rack.rb

@@ -1,6 +1,7 @@
 require 'progressive_render/rack/request_handler'
 
 module ProgressiveRender
-	module Rack
-	end
-end
+  # Rack specific functionality
+  module Rack
+  end
+end

data/lib/progressive_render/rails/controller.rb

@@ -1,54 +1,58 @@
 require 'progressive_render/rails/helpers'
 
 module ProgressiveRender
-module Rails
+  module Rails
+    # Rails controller methods, this module is installed into ActionController
+    # These methods should not generally be called by user code besides 'render'
+    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
 
-module Controller
-  include Helpers
+      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.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 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
+      private
 
-  def resolve_path(template)
-    tc = Rails::PathResolver::TemplateContext.new
-    tc.type       = :controller
-    tc.controller = request.params["controller"]
-    tc.action     = request.params["action"]
+      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 = 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
+        pr.path_for(template)
       end
-    end
-  end
 
-  def in_progressive_render?
-    @in_progressive_render
-  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
+      # 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
+        @in_progressive_render = true
+        yield
+        @in_progressive_render = false
+      end
+    end
   end
 end
-
-end
-end

data/lib/progressive_render/rails/engine.rb

@@ -1,21 +1,23 @@
 module ProgressiveRender
-module Rails
+  module Rails
+    # Rails uses this class to install progressive_render into an application
+    # It is responsible for any setup needed for the gem to function
+    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
 
-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
+      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
-end

data/lib/progressive_render/rails/helpers.rb

@@ -1,14 +1,14 @@
 module ProgressiveRender
-module Rails
+  module Rails
+    # Shortcuts to object creation used in the view and controller
+    module Helpers
+      def progressive_request
+        @rh ||= Rack::RequestHandler.new(request)
+      end
 
-module Helpers
-	def progressive_request
-		@rh ||= Rack::RequestHandler.new(request)
-	end
-	def progressive_renderer
-		Rails::ViewRenderer.new(self)
-	end
+      def progressive_renderer
+        Rails::ViewRenderer.new(self)
+      end
+    end
+  end
 end
-
-end
-end

data/lib/progressive_render/rails/path_resolver.rb

@@ -1,44 +1,61 @@
 module ProgressiveRender
-	module Rails
-		class PathResolver
-			class TemplateContext
-				attr_accessor :controller, :action, :type
-
-				def valid?
-					return false if type != :view && type != :controller
-					return false if controller.nil? or controller.empty?
-					return false if action.nil? or action.empty?
-					true
-				end
-			end
-
-			class InvalidTemplateContextException < Exception
-			end
-
-			class InvalidPathException < Exception
-			end
-
-			def initialize(_template_context)
-				@context = _template_context
-			end
-
-			def path_for(view_name=nil)
-				raise InvalidTemplateContextException.new unless @context && @context.valid?
-				raise InvalidPathException.new if (view_name.nil? or view_name.empty?) and view_action?
-
-				path = "#{@context.controller.downcase}/"
-
-				if view_name == nil || view_name.empty?
-					path += "#{@context.action}"
-				else
-					path += "#{view_name}"
-				end
-			end
-
-			private
-			def view_action?
-				@context.type == :view
-			end
-		end
-	end
-end
+  module Rails
+    # Resolve set of request parameters to a full path to a template file
+    class PathResolver
+      # Holds the request parameters.
+      # Used to decouple the ProgressiveRequest from the renderer.
+      class TemplateContext
+        attr_accessor :controller, :action, :type
+
+        def valid?
+          valid_type? && valid_controller? && valid_action?
+        end
+
+        private
+
+        def valid_type?
+          type == :view || type == :controller
+        end
+
+        def valid_controller?
+          !controller.nil? && !controller.empty?
+        end
+
+        def valid_action?
+          !action.nil? && !action.empty?
+        end
+      end
+
+      class InvalidTemplateContextException < RuntimeError
+      end
+
+      class InvalidPathException < RuntimeError
+      end
+
+      def initialize(template_context)
+        @context = template_context
+      end
+
+      def path_for(view_name = nil)
+        raise InvalidTemplateContextException unless @context && @context.valid?
+        raise InvalidPathException if (view_name.nil? || view_name.empty?) && view_action?
+
+        "#{@context.controller.downcase}/#{path_suffix_for(view_name)}"
+      end
+
+      private
+
+      def path_suffix_for(view_name)
+        if view_name.nil? || view_name.empty?
+          @context.action.to_s
+        else
+          view_name.to_s
+        end
+      end
+
+      def view_action?
+        @context.type == :view
+      end
+    end
+  end
+end

data/lib/progressive_render/rails/view.rb

@@ -1,39 +1,64 @@
 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
+  module Rails
+    # Provides methods for application view
+    module View
+      include Helpers
+
+      # Mark a section of content to be loaded after initial view of the page.
+      #
+      # == Usage
+      #  <%= progressive_render do %>
+      #    <h2>Content!</h2>
+      #  <% end %>
+      #
+      # == Specify a custom placeholder
+      # The progressive_render method puts a simple spinner on the page by default but
+      # that can be customized per section by passing a path to a partial via `placeholder`
+      #
+      #  <%= progressive_render placeholder: 'shared/custom_placehodler' do %>
+      #    <h2>More Content!</h2>
+      #  <% end %>
+      def progressive_render(deprecated_fragment_name = nil,
+                             placeholder: 'progressive_render/placeholder')
+        if deprecated_fragment_name
+          logger.warn %(DEPRECATED (progressive_render): Literal fragment names are deprecated and will be removed
+            in v1.0. The fragment name (#{deprecated_fragment_name}) will be ignored.")
+        end
+
+        progressive_render_impl(placeholder: placeholder) do
+          yield
+        end
+      end
+
+      private
+
+      def progressive_render_impl(placeholder: 'progressive_render/placeholder')
+        fragment_name = fragment_name_iterator.next!
+
+        progressive_render_content(fragment_name, progressive_request.main_load?) do
+          if progressive_request.main_load?
+            progressive_renderer.render_partial placeholder
+          elsif progressive_request.should_render_fragment?(fragment_name)
+            yield
+          end
+        end
+      end
+
+      def progressive_render_content(fragment_name, placeholder = true)
+        data = { progressive_render_placeholder: placeholder,
+                 progressive_render_path: progressive_request.load_path(fragment_name) }.select { |_k, v| !v.nil? }
+
+        content_tag(:div, id: "#{fragment_name}_progressive_render",
+                          data: data) do
+          yield
+        end
+      end
 
+      def fragment_name_iterator
+        @fni ||= FragmentNameIterator.new
+      end
+    end
+  end
 end
-end

data/lib/progressive_render/rails/view_renderer.rb

@@ -2,17 +2,21 @@ require 'nokogiri'
 
 module ProgressiveRender
   module Rails
+    # Responsible for rendering a full page and extracting fragments for a progressive render.
     class ViewRenderer
       attr_accessor :context
-      def initialize(_view_context)
-        self.context = _view_context
+      def initialize(view_context)
+        self.context = view_context
       end
+
       def render_partial(path)
         context.render partial: path
       end
+
       def render_view(path)
         context.render path
       end
+
       def render_fragment(path, fragment_name)
         content = context.render_to_string template: path, layout: false
         stripped = Nokogiri::HTML(content).at_css("div##{fragment_name}_progressive_render")

data/lib/progressive_render/rails.rb

@@ -7,6 +7,7 @@ require 'progressive_render/rails/view'
 require 'progressive_render/rails/controller'
 
 module ProgressiveRender
-	module Rails
-	end
-end
+  # Rails specific functionality
+  module Rails
+  end
+end

data/lib/progressive_render/version.rb

@@ -1,3 +1,3 @@
 module ProgressiveRender
-  VERSION = "0.4.1"
+  VERSION = '0.4.3'.freeze
 end

data/lib/progressive_render.rb

@@ -2,10 +2,11 @@ require 'progressive_render/rack'
 
 require 'progressive_render/fragment_name_iterator'
 
+# Root namespace for the gem
 module ProgressiveRender
-	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
+  if defined?(::Rails) && Gem::Requirement.new('>= 3.1').satisfied_by?(Gem::Version.new(::Rails.version))
+    require 'progressive_render/rails'
+  else
+    logger.warn 'progressive_render gem has not been installed due to missing dependencies'
+  end
+end

data/progressive_load.gemspec

@@ -4,35 +4,38 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'progressive_render/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "progressive_render"
+  spec.name          = 'progressive_render'
   spec.version       = ProgressiveRender::VERSION
-  spec.authors       = ["Jeff Johnson"]
-  spec.email         = ["johnsonjeff@gmail.com"]
+  spec.authors       = ['Jeff Johnson']
+  spec.email         = ['johnsonjeff@gmail.com']
 
-  spec.summary       = %q{Progressively load static or dynamic content on page load}
-  spec.description   = %q{For large or expensive pages, use this gem to load less critical portions of the page. Especially useful for large queries or content that's hidden from the user on load. The best solution may be to optimize your content, but there's not always time for that.}
-  spec.homepage      = "https://github.com/johnsonj/progressive_render"
-  spec.license       = "MIT"
+  spec.summary       = 'Progressively load static or dynamic content on page load'
+  spec.description   = %(For large or expensive pages, use this gem to load less critical portions of the page.
+                          Especially useful for large queries or content that's hidden from the user on load.
+                          The best solution may be to optimize your content, but there's not always time for that.)
+  spec.homepage      = 'https://github.com/johnsonj/progressive_render'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "codeclimate-test-reporter"
-  spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rubocop'
 
-  spec.add_dependency "sass"
-  spec.add_dependency "sass-rails"
-  spec.add_dependency "uglifier"
-  spec.add_dependency "coffee-rails"
-  spec.add_dependency "railties"
-  spec.add_dependency "jquery-rails"
-  spec.add_dependency "rails", ">= 4.1"
-  spec.add_dependency "nokogiri"
+  spec.add_dependency 'sass'
+  spec.add_dependency 'sass-rails'
+  spec.add_dependency 'uglifier'
+  spec.add_dependency 'coffee-rails'
+  spec.add_dependency 'railties'
+  spec.add_dependency 'jquery-rails'
+  spec.add_dependency 'rails', '>= 4.1'
+  spec.add_dependency 'nokogiri'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progressive_render
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Jeff Johnson
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -220,10 +234,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: For large or expensive pages, use this gem to load less critical portions
-  of the page. Especially useful for large queries or content that's hidden from the
-  user on load. The best solution may be to optimize your content, but there's not
-  always time for that.
+description: |-
+  For large or expensive pages, use this gem to load less critical portions of the page.
+                            Especially useful for large queries or content that's hidden from the user on load.
+                            The best solution may be to optimize your content, but there's not always time for that.
 email:
 - johnsonjeff@gmail.com
 executables: []
@@ -232,6 +246,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Appraisals
 - DESIGN.md
@@ -242,6 +258,7 @@ files:
 - app/views/progressive_render/_placeholder.html.erb
 - bin/console
 - bin/setup
+- bump_version.sh
 - gemfiles/rails_4_1.gemfile
 - gemfiles/rails_4_1.gemfile.lock
 - gemfiles/rails_4_2.gemfile