Class: StimulusSpec::Matchers::HaveStimulusClass

Inherits:
Object
  • Object
show all
Defined in:
lib/stimulus_spec/matchers/have_stimulus_class.rb

Overview

Asserts that rendered HTML contains a +data-controller-name-class+ attribute.

Examples:

Existence check

expect(response).to have_stimulus_class("search", "loading")

Equality check

expect(response).to have_stimulus_class("search", "loading", "opacity-50")

Instance Method Summary collapse

Constructor Details

#initialize(controller, name, expected = nil) ⇒ HaveStimulusClass

Returns a new instance of HaveStimulusClass.

Parameters:

  • controller (String) —

    controller name

  • name (String) —

    class name

  • expected (String, nil) (defaults to: nil) —

    expected attribute value (omit for existence check)



15
16
17
18
19
20
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 15

def initialize(controller, name, expected = nil)
  @controller = controller.to_s
  @name = name.to_s
  @expected = expected
  @attr = "data-#{@controller}-#{@name}-class"
end

Instance Method Details

#description ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 59

def description
  if @expected
    "have Stimulus class \"#{@name}\" with \"#{@expected}\" for controller \"#{@controller}\""
  else
    "have Stimulus class \"#{@name}\" for controller \"#{@controller}\""
  end
end

#does_not_match?(subject) ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 43

def does_not_match?(subject)
  !matches?(subject)
end

#failure_message ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 47

def failure_message
  if @expected && @actual
    "expected #{@attr} to be \"#{@expected}\" but was \"#{@actual}\"\n  on: #{@element.to_html}"
  else
    "expected to find an element with #{@attr} but found none in:\n#{snippet}"
  end
end

#failure_message_when_negated ⇒ Object 



55
56
57
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 55

def failure_message_when_negated
  "expected not to find an element with #{@attr} but found one"
end

#matches?(subject) ⇒ Boolean

Parameters:

  • subject (#body, String) —

    response object or HTML string

Returns:

  • (Boolean) 


31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 31

def matches?(subject)
  @body = extract_body(subject)
  @doc = Nokogiri::HTML5.fragment(@body)
  @element = search_root&.at_css("[#{@attr}]")
  return false unless @element

  return true unless @expected

  @actual = @element[@attr]
  @actual == @expected.to_s
end

#within(selector) ⇒ self

Parameters:

  • selector (String) —

    CSS selector for the scope element

Returns:

  • (self) 


24
25
26
27
 
# File 'lib/stimulus_spec/matchers/have_stimulus_class.rb', line 24

def within(selector)
  @scope = selector
  self
end