123456789_123456789_123456789_123456789_123456789_

Module: Capybara::SessionMatchers

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Session
Defined in: lib/capybara/session/matchers.rb

Instance Method Summary

Instance Method Details

#_verify_current_path(path, filter_block, **options) (private)

[ GitHub ] 

  


# File 'lib/capybara/session/matchers.rb', line 72



def _verify_current_path(path, filter_block, **options)
  query = Capybara::Queries::CurrentPathQuery.new(path, **options, &filter_block)
  document.synchronize(query.wait) do
    yield(query)
  end
  true
end


  








  

    

      #assert_current_path(string, **options)  ⇒ true 
      #assert_current_path(regexp, **options)  ⇒ true 
    

  



  

    

Asserts that the page has the given path. By default, if passed a full url this will compare against the full url, if passed a path only the path+query portion will be compared, if passed a regexp the comparison will depend on the :url option (path+query by default)


  





  
Parameters:


    
  
  • 
    options
    (Hash)
—    
    

    a customizable set of options
    

    
  
    • 


    
Options Hash (**options):

    
    
        
  • 
          :url
          (Boolean)
           — default:
              true if {string} is a full url, otherwise false          
            — 
    

    Whether the comparison should be done against the full current url or just the path
    

            
    • 
        
  • 
          :ignore_query
          (Boolean)
           — default:
              false          
            — 
    

    Whether the query portion of the current url/path should be ignored
    

            
    • 
        
  • 
          :wait
          (Numeric)
           — default:
              Capybara.default_max_wait_time          
            — 
    

    Maximum time that ::Capybara will wait for the current url/path to eq/match given string/regexp argument
    

            
    • 
    


Raises:





  [ GitHub ]


  

  


# File 'lib/capybara/session/matchers.rb', line 22



def assert_current_path(path, **options, &optional_filter_block)
  _verify_current_path(path, optional_filter_block, **options) do |query|
    raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
  end
end


  








  

    

      #assert_no_current_path(string, **options)  ⇒ true 
      #assert_no_current_path(regexp, **options)  ⇒ true 
    

  



  

    

Asserts that the page doesn’t have the given path. By default, if passed a full url this will compare against the full url, if passed a path only the path+query portion will be compared, if passed a regexp the comparison will depend on the :url option


  





  
Parameters:


    
  
  • 
    options
    (Hash)
—    
    

    a customizable set of options
    

    
  
    • 


    
Options Hash (**options):

    
    
        
  • 
          :url
          (Boolean)
           — default:
              true if {string} is a full url, otherwise false          
            — 
    

    Whether the comparison should be done against the full current url or just the path
    

            
    • 
        
  • 
          :ignore_query
          (Boolean)
           — default:
              false          
            — 
    

    Whether the query portion of the current url/path should be ignored
    

            
    • 
        
  • 
          :wait
          (Numeric)
           — default:
              Capybara.default_max_wait_time          
            — 
    

    Maximum time that ::Capybara will wait for the current url/path to eq/match given string/regexp argument
    

            
    • 
    


Raises:





  [ GitHub ]


  

  


# File 'lib/capybara/session/matchers.rb', line 38



def assert_no_current_path(path, **options, &optional_filter_block)
  _verify_current_path(path, optional_filter_block, **options) do |query|
    raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
  end
end


  








  

    

      #has_current_path?(string, **options)  ⇒ Boolean 
      #has_current_path?(regexp, **options)  ⇒ Boolean 
    

  



  

    

Checks if the page has the given path. By default, if passed a full url this will compare against the full url, if passed a path only the path+query portion will be compared, if passed a regexp the comparison will depend on the :url option


  





  
Parameters:


    
  
  • 
    options
    (Hash)
—    
    

    a customizable set of options
    

    
  
    • 


    
Options Hash (**options):

    
    
        
  • 
          :url
          (Boolean)
           — default:
              true if {string} is a full url, otherwise false          
            — 
    

    Whether the comparison should be done against the full current url or just the path
    

            
    • 
        
  • 
          :ignore_query
          (Boolean)
           — default:
              false          
            — 
    

    Whether the query portion of the current url/path should be ignored
    

            
    • 
        
  • 
          :wait
          (Numeric)
           — default:
              Capybara.default_max_wait_time          
            — 
    

    Maximum time that ::Capybara will wait for the current url/path to eq/match given string/regexp argument
    

            
    • 
    




  [ GitHub ]


  

  


# File 'lib/capybara/session/matchers.rb', line 53



def has_current_path?(path, **options, &optional_filter_block)
  make_predicate(options) { assert_current_path(path, **options, &optional_filter_block) }
end


  








  

    

      #has_no_current_path?(string, **options)  ⇒ Boolean 
      #has_no_current_path?(regexp, **options)  ⇒ Boolean 
    

  



  

    

Checks if the page doesn’t have the given path. By default, if passed a full url this will compare against the full url, if passed a path only the path+query portion will be compared, if passed a regexp the comparison will depend on the :url option


  





  
Parameters:


    
  
  • 
    options
    (Hash)
—    
    

    a customizable set of options
    

    
  
    • 


    
Options Hash (**options):

    
    
        
  • 
          :url
          (Boolean)
           — default:
              true if {string} is a full url, otherwise false          
            — 
    

    Whether the comparison should be done against the full current url or just the path
    

            
    • 
        
  • 
          :ignore_query
          (Boolean)
           — default:
              false          
            — 
    

    Whether the query portion of the current url/path should be ignored
    

            
    • 
        
  • 
          :wait
          (Numeric)
           — default:
              Capybara.default_max_wait_time          
            — 
    

    Maximum time that ::Capybara will wait for the current url/path to eq/match given string/regexp argument
    

            
    • 
    




  [ GitHub ]


  

  


# File 'lib/capybara/session/matchers.rb', line 66



def has_no_current_path?(path, **options, &optional_filter_block)
  make_predicate(options) { assert_no_current_path(path, **options, &optional_filter_block) }
end


  








  

    #make_predicate(options)   (private)
  

  [ GitHub ]


  

  


# File 'lib/capybara/session/matchers.rb', line 80



def make_predicate(options)
  options[:wait] = 0 unless options.key?(:wait) || config.predicates_wait
  yield
rescue Capybara::ExpectationNotMet
  false
end