Skip to content

Fix empty view rendering #1557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Fix empty view rendering #1557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b104bf
basic spec showing the behaviour of the modified path decorators
JonRowe Feb 23, 2016
eee3d0e
add spec covering regression where arrays where not supported for app…
JonRowe Feb 23, 2016
da88413
prevent error when path has resolvers appended, but keep null rendering
JonRowe Feb 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions lib/rspec/rails/view_rendering.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ def render_views?
#
# @private
class EmptyTemplateResolver < ::ActionView::FileSystemResolver

def initialize(path, pattern=nil)
unless path.is_a?(::ActionView::Resolver)
super
end
end

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this just end up adding an uninitialised EmptyTemplateResolver to the view paths array?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but that's the point, the parts of this that are used are here and don't depend on initialisation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bit is to fix #1551 isn't it? If so adding your custom resolver instance to the view path with result in an instance of EmptyTemplateResolver with a nil path instance variable instead. I thought the idea would be to put the custom resolver into the path without wrapping it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want a custom resolver in the path, the aim is to disable view rendering, my understanding is that would do the opposite.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but it'd generate template missing errors because find_templates would be called on the EmptyTemplateResolver instance and not the custom resolver instance.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well we need to find a way to pass the details of the resolver down into that implementation without loosing this subclass, alternatively we could monkey patch the instance of the resolver with the required methods but I'd rather not do that, that seems dangerous

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that when path is a Resolver instance, it knows how to look up templates. And the super call in this EmptyTemplateResolver#find_templates doesn’t call up to that resolver.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see #1568 #1580 for a changed implementation that works for my spec suite.

Update: #1568 has been superseded by #1580.

private

def find_templates(*args)
Expand Down Expand Up @@ -71,17 +78,17 @@ def self.call(_template)
# @private
module EmptyTemplates
def prepend_view_path(new_path)
lookup_context.view_paths.unshift(*_path_decorator(new_path))
lookup_context.view_paths.unshift(*_path_decorator(*new_path))
end

def append_view_path(new_path)
lookup_context.view_paths.push(*_path_decorator(new_path))
lookup_context.view_paths.push(*_path_decorator(*new_path))
end

private

def _path_decorator(path)
EmptyTemplateResolver.new(path)
def _path_decorator(*paths)
paths.map { |path| EmptyTemplateResolver.new(path) }
end
end

Expand Down
29 changes: 29 additions & 0 deletions spec/rspec/rails/view_rendering_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,34 @@ def example.controller
end
end
end

context 'when render_views? is false' do
let(:controller) { ActionController::Base.new }

before { controller.extend(ViewRendering::EmptyTemplates) }

it 'supports manipulating view paths' do
controller.prepend_view_path 'app/views'
controller.append_view_path 'app/others'
expect(controller.view_paths.map(&:to_s)).to match_paths 'app/views', 'app/others'
end

it 'supports manipulating view paths with arrays' do
controller.prepend_view_path ['app/views', 'app/legacy_views']
controller.append_view_path ['app/others', 'app/more_views']
expect(controller.view_paths.map(&:to_s)).to match_paths 'app/views', 'app/legacy_views', 'app/others', 'app/more_views'
end

it 'supports manipulating view paths with resolvers' do
expect {
controller.prepend_view_path ActionView::Resolver.new
controller.append_view_path ActionView::Resolver.new
}.to_not raise_error
end

def match_paths(*paths)
eq paths.map { |path| File.expand_path path }
end
end
end
end