Skip to content
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

append/prepend_view_path support in actions #99

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

append/prepend_view_path support in actions #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions app/views/_xray_bar.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
</span>
<% end %>
<% if Xray.request_info[:view] && Xray.request_info.fetch(:controller, {})[:name] != "Rails::InfoController" %>
<% lookup_context.view_paths.unshift(*Xray.request_info.fetch(:view_paths, {}).fetch(:prepend, [])) %>
<% lookup_context.view_paths.push(*Xray.request_info.fetch(:view_paths, {}).fetch(:append, [])) %>
<% layout_path = lookup_context.find(Xray.request_info[:view][:layout]).identifier %>
<span class="xray-bar-btn xray-bar-layout xray-icon-columns" data-path="<%= layout_path %>">
<b></b>
Expand Down
21 changes: 21 additions & 0 deletions lib/xray/engine.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@ def render_with_xray(*args, &block)
xray_method_alias :render
end

ActionView::ViewPaths.class_eval do
extend Xray::Aliasing

def append_view_path_with_xray(args)
source = prepend_view_path_without_xray(args)
Xray.request_info[:view_paths] ||= {}
Xray.request_info[:view_paths][:append] ||= []
Xray.request_info[:view_paths][:append] += [*args]
source
end
xray_method_alias :append_view_path
def prepend_view_path_with_xray(args)
source = prepend_view_path_without_xray(args)
Xray.request_info[:view_paths] ||= {}
Xray.request_info[:view_paths][:prepend] ||= []
Xray.request_info[:view_paths][:prepend] += [*args]
source
end
xray_method_alias :prepend_view_path
end

# Sprockets preprocessor interface which supports all versions of Sprockets.
# See: https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#supporting-all-versions-of-sprockets-in-processors
class JavascriptPreprocessor
Expand Down
18 changes: 18 additions & 0 deletions spec/dummy/app/controllers/application_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
class ApplicationController < ActionController::Base
protect_from_forgery
layout 'another', only: %i(appended_view_path appended_view_path_without_xray prepended_view_path prepended_view_path_without_xray)

def root
end
Expand All @@ -12,4 +13,21 @@ def non_html
def made_with_haml
respond_to :json
end

def appended_view_path
append_view_path [Rails.root.join('app', 'views', 'variant_1'), Rails.root.join('app', 'views', 'variant_2')]
render :additional_view
end
def prepended_view_path
prepend_view_path [Rails.root.join('app', 'views', 'variant_1'), Rails.root.join('app', 'views', 'variant_2')]
render :additional_view
end
def appended_view_path_without_xray
append_view_path_without_xray [Rails.root.join('app', 'views', 'variant_1'), Rails.root.join('app', 'views', 'variant_2')]
render :additional_view
end
def prepended_view_path_without_xray
prepend_view_path_without_xray [Rails.root.join('app', 'views', 'variant_1'), Rails.root.join('app', 'views', 'variant_2')]
render :additional_view
end
end
5 changes: 5 additions & 0 deletions spec/dummy/app/views/variant_2/application/additional_view.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<div class="container">
Element in the additional view.
</div>

<%= render partial: 'simple_partial' %>
18 changes: 18 additions & 0 deletions spec/dummy/app/views/variant_2/layouts/another.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<title>Xray</title>
<%= stylesheet_link_tag "application", :media => "all" %>
<%= javascript_include_tag "application" %>
<%= csrf_meta_tags %>
</head>
<body>

<div class="container">
Layout in the additional view path.
</div>

<%= yield %>

</body>
</html>
52 changes: 52 additions & 0 deletions spec/xray/engine_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,57 @@
expect(subject.render(*xray_enabled_render_args)).to eql(nil)
end
end

context 'ActionView::ViewPaths monkeypatch' do
context 'on adding single variant path' do
let(:view_path_arg) { Rails.root.join('app', 'views', 'variant_1') }

context '#append_view_path' do
subject { Xray.request_info[:view_paths][:append] }

it 'should append additional view paths to Xray.request_info[:view_paths][:append]' do
allow_any_instance_of(ActionView::LookupContext).to receive(:append_view_path_without_xray).with(view_path_arg)
allow_any_instance_of(ActionView::LookupContext).to receive(:append_view_path).with(view_path_arg)
ActionController::Base.new.append_view_path view_path_arg
is_expected.to include(view_path_arg)
end
end
context '#prepend_view_path' do
subject { Xray.request_info[:view_paths][:prepend] }

it 'should prepend additional view paths to Xray.request_info[:view_paths][:prepend]' do
allow_any_instance_of(ActionView::LookupContext).to receive(:prepend_view_path_without_xray).with(view_path_arg)
allow_any_instance_of(ActionView::LookupContext).to receive(:prepend_view_path).with(view_path_arg)
ActionController::Base.new.prepend_view_path(view_path_arg)
is_expected.to include(view_path_arg)
end
end
end

context 'on adding arrayed variant path' do
let(:view_path_arg) { [Rails.root.join('app', 'views', 'variant_1'), Rails.root.join('app', 'views', 'variant_2')] }

context '#append_view_path' do
subject { Xray.request_info[:view_paths][:append] }

it 'should append additional view paths to Xray.request_info[:view_paths][:append]' do
allow_any_instance_of(ActionView::LookupContext).to receive(:append_view_path_with_xray).with(view_path_arg)
allow_any_instance_of(ActionView::LookupContext).to receive(:append_view_path).with(view_path_arg)
ActionController::Base.new.append_view_path view_path_arg
is_expected.to include(*view_path_arg)
end
end
context '#prepend_view_path' do
subject { Xray.request_info[:view_paths][:prepend] }

it 'should prepend additional view paths to Xray.request_info[:view_paths][:prepend]' do
allow_any_instance_of(ActionView::LookupContext).to receive(:prepend_view_path_without_xray).with(view_path_arg)
allow_any_instance_of(ActionView::LookupContext).to receive(:prepend_view_path).with(view_path_arg)
ActionController::Base.new.prepend_view_path view_path_arg
is_expected.to include(*view_path_arg)
end
end
end
end
end

64 changes: 56 additions & 8 deletions spec/xray/xray_bar_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,65 @@
require 'spec_helper'

describe "Xray Bar" do
before { visit '/' }
describe "Xray Bar", type: :request do
subject { find("#xray-bar") }

it "includes the controller and action" do
find('#xray-bar').should have_text('ApplicationController#root')
context "includes an #xray-bar element" do
before { visit '/' }

it "with the controller and action" do
is_expected.to have_text('ApplicationController#root')
end

it "with the layout used" do
is_expected.to have_text('application.html.erb')
end

it "with the view rendered" do
is_expected.to have_text('root.html.erb')
end
end

it "includes the layout used" do
find('#xray-bar').should have_text('application.html.erb')
context "with views in paths" do
context "appended by #append_view_path_without_xray" do
let(:path) { "/appended_view_path_without_xray" }

it "should not resolve the layout location" do
get path
expect(response).to have_http_status(500)
end
end

context "prepended by #prepend_view_path_without_xray" do
let(:path) { "/prepended_view_path_without_xray" }

it "should not resolve the layout location" do
get path
expect(response).to have_http_status(500)
end
end
end

it "includes the view rendered" do
find('#xray-bar').should have_text('root.html.erb')
context "with views in paths" do
let(:layout) { "another.html.erb" }
let(:view) { "additional_view.html.erb" }
before { visit path }

context "appended by #append_view_path" do
let(:path) { "/appended_view_path" }

it "should resolve the layout location" do
is_expected.to have_text(layout)
is_expected.to have_text(view)
end
end

context "prepended by #prepend_view_path" do
let(:path) { "/prepended_view_path" }

it "should resolve the layout location" do
is_expected.to have_text(layout)
is_expected.to have_text(view)
end
end
end
end