[Fixes browsermedia#689] Portlets with parameters

Portlets that have parameters (other than id) will now work when being viewed in the edit mode. There may be issues if portlets want an :id paremeter since there is assumed to be the page id. Hopefully this won't be a problem in practice since Addressable content could be used (or upgrading sites can scope the parameter to something thing_id) * Set up scenarios to cover portlets that have/need parameters * Add the existing params to the content iframe link.

Author: peakpg

app/controllers/cms/content_controller.rb

@@ -67,6 +67,9 @@ def assign(key, value)
 
  def render_editing_frame
  @page_title = @page.page_title
+
+ # Adds all provided parameters to the iframe
+ @edit_page_path = ActionDispatch::Http::URL.url_for(path: edit_content_path(current_page), params: params.except(:controller, :action, :path), only_path: true)
  render 'editing_frame', :layout => 'cms/page_editor'
  end
 

app/views/cms/content/editing_frame.html.erb

@@ -1 +1 @@
-<%= page_content_iframe(edit_content_path(current_page)) %>
+<%= page_content_iframe(@edit_page_path) %>

features/portlets/portlets_with_params.feature

@@ -0,0 +1,21 @@
+Feature: Portlets with Parameters
+ Portlets should be able to read request parameters and display content accordingly.
+
+ Background:
+ Given there is a portlet that finds content by parameter
+
+ # Finding content by id should be less necessary now that the Addressable Content feature is available.
+ # However, this feature is still available and backwards compatible.
+ Scenario: Find Content by parameter
+ Given I am not logged in
+ When I view that Find Content Portlet
+ Then I should see the content loaded by that Portlet
+
+ Scenario: Find Content by parameter
+ Given I am logged in as a Content Editor
+ And I view that Find Content Portlet in the page editor
+ Then I should see the content loaded by that Portlet
+
+
+
+

features/step_definitions/portlets_steps.rb

@@ -101,4 +101,28 @@
  refute page.has_content?('Error'), "The word 'Error' should not appear on the page"
  assert page.has_content?('hello'), "Should see other content"
  should_see_a_page_named(most_recently_created_page.title)
+end
+
+Given /^there is a portlet that finds content by parameter$/ do
+ @expected_page = create(:public_page)
+ @find_content_portlet = FindCategoryPortlet.create(name: 'Find Content')
+ @expected_page.add_content(@find_content_portlet)
+ @expected_page.publish!
+ @content = create(:category, name: 'I worked')
+end
+
+When /^I view that Find Content Portlet$/ do
+ visit "#{@expected_page.path}?category_id=#{@content.id}"
+end
+
+Then /^I should see the content loaded by that Portlet$/ do
+ should_be_successful
+ should_see_a_page_titled @expected_page.name
+ assert page.has_content?(@content.name)
+ assert page.has_content?("Pass.")
+end
+
+When /^I view that Find Content Portlet in the page editor$/ do
+ visit "#{@expected_page.path}?category_id=#{@content.id}"
+ visit_content_iframe
 end

features/support/cms_api.rb

@@ -49,11 +49,16 @@ def most_recently_created_page
  # </pre>
  def within_content_frame
  if page_has_editor_iframe?
- visit find(editor_iframe_selector)['src']
+ visit_content_iframe
  end
  yield
  end
 
+ # View the content iframe as a top level page.
+ def visit_content_iframe
+ visit find(editor_iframe_selector)['src']
+ end
+
  def page_has_editor_iframe?
  page.has_selector?(editor_iframe_selector)
  end

test/dummy/app/portlets/find_category_portlet.rb

@@ -0,0 +1,15 @@
+class FindCategoryPortlet < Cms::Portlet
+
+ description "[TEST] Verify that portlets can read parameters."
+
+ # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+ enable_template_editor false
+ 
+ def render
+ @expected_parameter = params[:category_id]
+ if @expected_parameter
+ @category = Cms::Category.where(id: @expected_parameter).first # Explicitly want to return nil rather than NotFound
+ end
+ end
+ 
+end

test/dummy/app/portlets/helpers/find_category_portlet_helper.rb

@@ -0,0 +1,5 @@
+##
+# All methods from this helper will be available in the render.html.erb for FindCategoryPortlet
+module FindCategoryPortletHelper
+ 
+end

test/dummy/app/views/portlets/find_category/_form.html.erb

@@ -0,0 +1,2 @@
+<%= f.input :name %>
+<%= f.input :template, as: :template_editor %>

test/dummy/app/views/portlets/find_category/render.html.erb

@@ -0,0 +1,7 @@
+<% if @category %>
+ Pass. Found category <%= @category.name %>
+<% elsif @expected_parameter.blank? %>
+ Fail. param[:category_id] is missing.
+<% else %>
+ Fail. Could not find category with param[:category_id] = <%= @expected_parameter %>
+<% end %>

test/dummy/test/unit/portlets/find_category_portlet_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class FindCategoryTest < ActiveSupport::TestCase
+
+ test "Should be able to create new instance of a portlet" do
+ assert FindCategoryPortlet.create!(:name => "New Portlet")
+ end
+ 
+end