Contents

module PageMagic
  # module ClassMethods - contains class level methods for PageObjects
  module ClassMethods
    # Default block to be run when a page is loaded. This is used if a specific handler is not registered
    DEFAULT_ON_LOAD = proc {}

    # create an new page object instance based on top of the source supplied
    # @param [String] source html source code
    # @return [Object<InstanceMethods>] instance of class with all the same methods as normal PageMagic page objects.
    def load(source)
      new(Session.new(Capybara::Node::Simple.new(source)))
    end

    # sets block to run when page has loaded
    # if one has not been set on the page object class it will return a default block that does nothing
    def on_load(&block)
      return @on_load || DEFAULT_ON_LOAD unless block
      @on_load = block
    end

    # getter setter for storing the page url
    # @param [String] url the url of the page
    def url(url = nil)
      @url = url if url
      @url
    end

    # Visit this page based on the class level registered url
    # @param [Object] application rack application (optional)
    # @param [Symbol] browser name of browser
    # @param [Hash] options browser driver specific options
    # @return [Session] active session configured to be using an instance of the page object modeled by this class
    def visit(application: nil, browser: :rack_test, options: {})
      session_options = { browser: browser, options: options, url: url }
      session_options[:application] = application if application

      PageMagic.session(session_options).tap do |session|
        session.visit(self, url: url)
      end
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
page_magic-1.2.9	lib/page_magic/class_methods.rb
page_magic-1.2.8	lib/page_magic/class_methods.rb
page_magic-1.2.8.alpha	lib/page_magic/class_methods.rb
page_magic-1.2.7	lib/page_magic/class_methods.rb
page_magic-1.2.6	lib/page_magic/class_methods.rb
page_magic-1.2.5	lib/page_magic/class_methods.rb
page_magic-1.2.5.alpha1	lib/page_magic/class_methods.rb
page_magic-1.2.4	lib/page_magic/class_methods.rb
page_magic-1.2.3	lib/page_magic/class_methods.rb
page_magic-1.2.1	lib/page_magic/class_methods.rb
page_magic-1.2.0	lib/page_magic/class_methods.rb