Module: Brut::SpecSupport::ComponentSupport

Includes:
I18n::ForBackEnd, ClockSupport, FlashSupport, SessionSupport
Defined in:
lib/brut/spec_support/component_support.rb

Overview

Convienience methods for writing tests of components or pages.

Instance Method Summary collapse

Methods included from I18n::ForBackEnd

#capture, #html_escape, #safe

Methods included from I18n::BaseMethods

#l, #t, #t_direct, #this_field_value

Methods included from ClockSupport

#clock_at, #clock_in_timezone_at, #real_clock

Methods included from SessionSupport

#empty_session

Methods included from FlashSupport

#empty_flash, #flash_from

Instance Method Details

#generate_and_parse(component) { ... } ⇒ Brut::SpecSupport::EnhancedNode

Render a component or page and parse it into a Nokogiri Node for examination. There are several matchers you can use with the return value of this method:

  • ‘have_html_attribute` to check if a node has a value for an HTML attribute.

  • ‘have_i18n_string` to check if the text of a node is exactly an i18n string you have set up.

  • ‘have_link_to` to check that a node contains a link to a page or page routing

you are running.

Examples:


result = generate_and_parse(HeaderComponent.new(title: "Hello!")
expect(result.e!("h1").text).to eq("Hello!")

Parameters:

  • component (Brut::FrontEnd::Component) —

    the component instance you wish to generate. This should be set up to simulate the test

Yields:

  • if the component requires or accepts a yielded block, this is how you do that in the test.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/brut/spec_support/component_support.rb', line 58

def generate_and_parse(component,&block)
  rendered_text = generate_result(component,&block)
  if !rendered_text.kind_of?(String)
    if rendered_text.kind_of?(URI::Generic)
      raise "#{component.class} redirected to #{rendered_text} instead of generating HTML"
    else
      raise "#{component.class} returned a #{rendered_text.class} - you should not attempt to parse this.  Instead, call generate(component)"
    end
  end
  nokogiri_node = Nokogiri::HTML5(rendered_text)
  if !component.kind_of?(Brut::FrontEnd::Page)
    nokogiri_node = Nokogiri::HTML5.fragment(rendered_text.to_s.chomp, max_errors: 100, context: "template")
    if nokogiri_node.errors.any?
      raise "#{component.class} generated invalid HTML:\n\n#{rendered_text}\n\nErrors: #{nokogiri_node.errors.join(", ")}"
    end

    non_blank_text_elements = nokogiri_node.children.select { |element|
      is_text  = element.kind_of?(Nokogiri::XML::Text)
      is_blank = element.text.to_s.strip == ""

      is_blank_text = is_text && is_blank

      !is_blank_text
    }

    if non_blank_text_elements.size != 1
      raise "#{component.class} generated #{non_blank_text_elements.size} elements other than blank text:\n\n#{non_blank_text_elements.map(&:name)}. Components should generate a single element:\n#{rendered_text}"
    end
    nokogiri_node = non_blank_text_elements[0]
  end
  if nokogiri_node
    Brut::SpecSupport::EnhancedNode.new(nokogiri_node)
  else
    nil
  end
end

#generate_result(component, &block) ⇒ Object

Generate a component or page into its text representation. This mimics what happens when Brut generates the page or component. Note that pages don’t always return Strings, for example if ‘before_generate` returns a redirect.

When testing a component, call #generate_and_parse instead of this. When testing a page that will always generate HTML, again call #generate_and_parse.

When using this, there are some matchers that can help assert what the page has done:

  • ‘have_redirected_to` to check that the page redirected elsewhere, instead of generating HTML.

  • ‘have_returned_http_status` to check that the page returned an HTTP status instead of generating HTML.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/brut/spec_support/component_support.rb', line 24

def generate_result(component,&block)
  if component.kind_of?(Brut::FrontEnd::Page)
    if !block.nil?
      raise "pages do not accept blocks - do not pass one to generate_result or generate_and_parse"
    end
    component.handle!
  else
    if block.nil?
      component.call
    else
      component.call do
        component.raw(component.safe(block.()))
      end
    end
  end
end