How to write an RSpec matcher that respect's Capybara's within block?











up vote
0
down vote

favorite












I'm trying to write a custom RSpec matcher to be used in Rails system tests, running under Capybara — the idea is to match text while ignoring certain <span> tags with it.



This is the matcher:



RSpec::Matchers.define :have_cleaned_text do |text|
match do |content|
content.body.include?(text) || content.body.gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
end
end


and the HTML body of the page being tested:



<h1>Test Page</h1>
<div id='constraint'>
<p>Clean text</p>
<p>Broken<span class='separator'>|<span>text</p>
</div>


The first two tests pass:



within('#constraint') do
expect(page).to have_cleaned_text('Clean text')
expect(page).to have_cleaned_text('Broken text')
expect(page).not_to have_cleaned_text('Test Page') # fails!
end


…but the third fails, as have_cleaned_text is ignoring the within block and testing against the whole page.



How can I make my matcher respect the within block? I would have expected it to have been passed as content, not the whole page…










share|improve this question




























    up vote
    0
    down vote

    favorite












    I'm trying to write a custom RSpec matcher to be used in Rails system tests, running under Capybara — the idea is to match text while ignoring certain <span> tags with it.



    This is the matcher:



    RSpec::Matchers.define :have_cleaned_text do |text|
    match do |content|
    content.body.include?(text) || content.body.gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
    end
    end


    and the HTML body of the page being tested:



    <h1>Test Page</h1>
    <div id='constraint'>
    <p>Clean text</p>
    <p>Broken<span class='separator'>|<span>text</p>
    </div>


    The first two tests pass:



    within('#constraint') do
    expect(page).to have_cleaned_text('Clean text')
    expect(page).to have_cleaned_text('Broken text')
    expect(page).not_to have_cleaned_text('Test Page') # fails!
    end


    …but the third fails, as have_cleaned_text is ignoring the within block and testing against the whole page.



    How can I make my matcher respect the within block? I would have expected it to have been passed as content, not the whole page…










    share|improve this question


























      up vote
      0
      down vote

      favorite









      up vote
      0
      down vote

      favorite











      I'm trying to write a custom RSpec matcher to be used in Rails system tests, running under Capybara — the idea is to match text while ignoring certain <span> tags with it.



      This is the matcher:



      RSpec::Matchers.define :have_cleaned_text do |text|
      match do |content|
      content.body.include?(text) || content.body.gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
      end
      end


      and the HTML body of the page being tested:



      <h1>Test Page</h1>
      <div id='constraint'>
      <p>Clean text</p>
      <p>Broken<span class='separator'>|<span>text</p>
      </div>


      The first two tests pass:



      within('#constraint') do
      expect(page).to have_cleaned_text('Clean text')
      expect(page).to have_cleaned_text('Broken text')
      expect(page).not_to have_cleaned_text('Test Page') # fails!
      end


      …but the third fails, as have_cleaned_text is ignoring the within block and testing against the whole page.



      How can I make my matcher respect the within block? I would have expected it to have been passed as content, not the whole page…










      share|improve this question















      I'm trying to write a custom RSpec matcher to be used in Rails system tests, running under Capybara — the idea is to match text while ignoring certain <span> tags with it.



      This is the matcher:



      RSpec::Matchers.define :have_cleaned_text do |text|
      match do |content|
      content.body.include?(text) || content.body.gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
      end
      end


      and the HTML body of the page being tested:



      <h1>Test Page</h1>
      <div id='constraint'>
      <p>Clean text</p>
      <p>Broken<span class='separator'>|<span>text</p>
      </div>


      The first two tests pass:



      within('#constraint') do
      expect(page).to have_cleaned_text('Clean text')
      expect(page).to have_cleaned_text('Broken text')
      expect(page).not_to have_cleaned_text('Test Page') # fails!
      end


      …but the third fails, as have_cleaned_text is ignoring the within block and testing against the whole page.



      How can I make my matcher respect the within block? I would have expected it to have been passed as content, not the whole page…







      ruby-on-rails rspec capybara






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 18 at 14:12

























      asked Nov 18 at 13:45









      John Y

      658516




      658516
























          1 Answer
          1






          active

          oldest

          votes

















          up vote
          2
          down vote



          accepted










          In your example page is a Capybara session (which contains its current scope). When you call body (source and html are aliases) on a session it returns the HTML source of the document. Since you're looking for the HTML source of an element you need something like



          RSpec::Matchers.define :have_cleaned_text do |text|
          match do |session|
          session.current_scope[:innerHTML].include?(text) || session.current_scope[:innerHTML].gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
          end
          end


          Note that a matcher written like that won't have any waiting/retrying behavior, like the Capybara provided matchers, so you need to ensure your page is loaded/stable before using it.






          share|improve this answer





















            Your Answer






            StackExchange.ifUsing("editor", function () {
            StackExchange.using("externalEditor", function () {
            StackExchange.using("snippets", function () {
            StackExchange.snippets.init();
            });
            });
            }, "code-snippets");

            StackExchange.ready(function() {
            var channelOptions = {
            tags: "".split(" "),
            id: "1"
            };
            initTagRenderer("".split(" "), "".split(" "), channelOptions);

            StackExchange.using("externalEditor", function() {
            // Have to fire editor after snippets, if snippets enabled
            if (StackExchange.settings.snippets.snippetsEnabled) {
            StackExchange.using("snippets", function() {
            createEditor();
            });
            }
            else {
            createEditor();
            }
            });

            function createEditor() {
            StackExchange.prepareEditor({
            heartbeatType: 'answer',
            convertImagesToLinks: true,
            noModals: true,
            showLowRepImageUploadWarning: true,
            reputationToPostImages: 10,
            bindNavPrevention: true,
            postfix: "",
            imageUploader: {
            brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
            contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
            allowUrls: true
            },
            onDemand: true,
            discardSelector: ".discard-answer"
            ,immediatelyShowMarkdownHelp:true
            });


            }
            });














             

            draft saved


            draft discarded


















            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53361565%2fhow-to-write-an-rspec-matcher-that-respects-capybaras-within-block%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown

























            1 Answer
            1






            active

            oldest

            votes








            1 Answer
            1






            active

            oldest

            votes









            active

            oldest

            votes






            active

            oldest

            votes








            up vote
            2
            down vote



            accepted










            In your example page is a Capybara session (which contains its current scope). When you call body (source and html are aliases) on a session it returns the HTML source of the document. Since you're looking for the HTML source of an element you need something like



            RSpec::Matchers.define :have_cleaned_text do |text|
            match do |session|
            session.current_scope[:innerHTML].include?(text) || session.current_scope[:innerHTML].gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
            end
            end


            Note that a matcher written like that won't have any waiting/retrying behavior, like the Capybara provided matchers, so you need to ensure your page is loaded/stable before using it.






            share|improve this answer

























              up vote
              2
              down vote



              accepted










              In your example page is a Capybara session (which contains its current scope). When you call body (source and html are aliases) on a session it returns the HTML source of the document. Since you're looking for the HTML source of an element you need something like



              RSpec::Matchers.define :have_cleaned_text do |text|
              match do |session|
              session.current_scope[:innerHTML].include?(text) || session.current_scope[:innerHTML].gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
              end
              end


              Note that a matcher written like that won't have any waiting/retrying behavior, like the Capybara provided matchers, so you need to ensure your page is loaded/stable before using it.






              share|improve this answer























                up vote
                2
                down vote



                accepted







                up vote
                2
                down vote



                accepted






                In your example page is a Capybara session (which contains its current scope). When you call body (source and html are aliases) on a session it returns the HTML source of the document. Since you're looking for the HTML source of an element you need something like



                RSpec::Matchers.define :have_cleaned_text do |text|
                match do |session|
                session.current_scope[:innerHTML].include?(text) || session.current_scope[:innerHTML].gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
                end
                end


                Note that a matcher written like that won't have any waiting/retrying behavior, like the Capybara provided matchers, so you need to ensure your page is loaded/stable before using it.






                share|improve this answer












                In your example page is a Capybara session (which contains its current scope). When you call body (source and html are aliases) on a session it returns the HTML source of the document. Since you're looking for the HTML source of an element you need something like



                RSpec::Matchers.define :have_cleaned_text do |text|
                match do |session|
                session.current_scope[:innerHTML].include?(text) || session.current_scope[:innerHTML].gsub(%r{<span class=["']separator["'].*?>.*?</span>}, ' ').include?(text)
                end
                end


                Note that a matcher written like that won't have any waiting/retrying behavior, like the Capybara provided matchers, so you need to ensure your page is loaded/stable before using it.







                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Nov 18 at 16:56









                Thomas Walpole

                29.2k32546




                29.2k32546






























                     

                    draft saved


                    draft discarded



















































                     


                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function () {
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53361565%2fhow-to-write-an-rspec-matcher-that-respects-capybaras-within-block%23new-answer', 'question_page');
                    }
                    );

                    Post as a guest















                    Required, but never shown





















































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown

































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown







                    Popular posts from this blog

                    Create new schema in PostgreSQL using DBeaver

                    Deepest pit of an array with Javascript: test on Codility

                    Costa Masnaga