rutl 0.3.0 → 0.4.0

data/lib/rutl/base_page.rb

@@ -1,111 +0,0 @@
-require 'rutl/interface/elements'
-require 'rutl/driver/null_driver'
-
-#
-# Base page class. It's used to call the magical method_messing
-# stuff to parse the page object files into actual objects.
-#
-class BasePage
-  # BUGBUG: Kludgy. What do I really want to do here?
-  # Make it easy to define a page's default url and
-  # also matchers for page urls for pages with variable urls?
-  # rubocop:disable Style/TrivialAccessors
-  def self.url
-    @url
-  end
-
-  def url
-    self.class.url
-  end
-  # rubocop:enable Style/TrivialAccessors
-
-  @@loaded_pages = []
-
-  def initialize(interface)
-    @interface = interface
-    # Dirty trick because we're loading all of page classes from files and then
-    # initializing them, calling their layout methods to do magic.
-    # The base_page class knows what pages are loaded.
-    return if @@loaded_pages.include?(self.class)
-    layout
-    @@loaded_pages << self.class
-  end
-
-  def go_to_here
-    # Ovveride this in base page to have something more
-    # complicated than this.
-    @interface.driver.navigate.to(url)
-  end
-
-  # Written by Browser and only used internally.
-  attr_writer :interface
-
-  def loaded?(driver)
-    url == driver.current_url
-  end
-
-  # Dynamically add a method, :<name> (or :<name>= if setter)
-  # to the current class where that method creates an instance
-  # of klass.
-  # context is an ElementContext
-  #
-  # As it is, this seems silly to break into pieces for Rubocop.
-  # rubocop:disable Metrics/MethodLength
-  def add_method(context:, klass:, name:, setter: false)
-    name = "#{name}_#{klass.downcase}"
-    constant = Module.const_get(klass.capitalize)
-    self.class.class_exec do
-      if setter
-        define_method("#{name}=") do |value|
-          constant.new(context, value)
-        end
-      else
-        define_method(name) do
-          constant.new(context)
-        end
-      end
-    end
-  end
-  # rubocop:enable Metrics/MethodLength
-
-  # This creates a new element instance whenever it's called.
-  # Because of that we can't keep state in any element objects.
-  # That seems like a good thing, actually.
-  # Called by layout method on pages.
-  #
-  # Hard to make shorter.
-  # rubocop:disable Metrics/MethodLength
-  def method_missing(element, *args, &_block)
-    name, selectors, rest = args
-    context = ElementContext.new(destinations: rest,
-                                 interface: @interface,
-                                 selectors: selectors)
-    case element
-    when /button/, /checkbox/, /link/
-      add_method(name: name, context: context, klass: element)
-    when /text/
-      add_method(name: name, context: context, klass: element)
-      add_method(name: name, context: context, klass: element, setter: true)
-    else
-      # TODO: replace with a super call. This is useful for debugging for now.
-      raise "#{element} NOT FOUND WITH ARGS #{args}!!!"
-    end
-  end
-  # rubocop:enable Metrics/MethodLength
-
-  def respond_to_missing?(*args)
-    # Is this right at all???
-    case args[0].to_s
-    when /button/, /checkbox/, /link/, /text/,
-         'driver', 'url', 'children', 'loaded?'
-      true
-    when 'ok_link'
-      raise 'OK LINK WAY DOWN HERE IN BASE PAGE!!!'
-    else
-      # I think it's good to raise but change the message.
-      raise 'Drew, you hit this most often when checking current page ' \
-            "rather than current page class:\n\n #{args}"
-      # I think I want to raise instead of returningn false.
-    end
-  end
-end

data/lib/rutl/driver/null_driver.rb

@@ -1,38 +0,0 @@
-require 'rutl/driver/null_driver_page_element'
-
-#
-# This is at a peer level to the webdrivers but it's for a fake brwoser.
-#
-class NullDriver
-  attr_accessor :context
-
-  def initialize(context)
-    raise 'no context' unless context.is_a?(ElementContext)
-    @context = context
-  end
-
-  def find_element(type, location)
-    # Return a new one of these so that it can be clicked ar written
-    # to or whatever.
-    context = ElementContext.new(interface: @context.interface)
-    NullDriverPageElement.new(context, type, location)
-  end
-
-  # Cheap way to handle browser.navigate.to(url)
-  # TODO: Until I care about the url and then I should ????
-  def navigate
-    context = ElementContext.new(interface: @context.interface)
-    NullDriver.new(context)
-  end
-
-  def to(url)
-    result = @context.interface.find_page(url)
-    @context.interface.current_page = result
-    result.url
-  end
-
-  def quit
-    # Clean out the @@variables.
-    NullDriverPageElement.clear_variables
-  end
-end

data/lib/rutl/driver/null_driver_page_element.rb

@@ -1,51 +0,0 @@
-require 'rutl/interface/elements/element_context'
-
-#
-# This fakes all page elements when used with the null driver.
-# It's a dirty way to avoid modeling all of what a driver talks to.
-#
-class NullDriverPageElement
-  attr_accessor :context
-
-  def self.clear_variables
-    @@variables = {}
-  end
-
-  def initialize(context, _type, location)
-    @@variables ||= {}
-    @context = context
-    @location = location
-  end
-
-  # @@string is a class variable because this framework creates new instances
-  # of each element every time it accesses them. This is good behavior by
-  # default because pages could change underneath us.
-  # For text fields in the null browser, though, we want to preserve the values
-  # across calls, letting us write and then read.
-  def send_keys(string)
-    init = @@variables[@location] || ''
-    @@variables[@location] = init + string
-  end
-
-  def attribute(attr)
-    case attr.to_sym
-    when :value
-      @@variables[@location] || ''
-    else
-      raise ArgumentError, "Attribute unknown: #{attr}"
-    end
-  end
-
-  def clear
-    @@variables[@location] = ''
-  end
-
-  def this_css
-    self
-  end
-
-  def click
-    # nop
-    # Called by ClickToChangeStateMixin like Selenium driver.click
-  end
-end

data/lib/rutl/interface/elements.rb

@@ -1,5 +0,0 @@
-require 'rutl/interface/elements/button'
-require 'rutl/interface/elements/checkbox'
-require 'rutl/interface/elements/link'
-require 'rutl/interface/elements/text'
-require 'rutl/interface/elements/element_context'

data/lib/rutl/interface/elements/base_element.rb

@@ -1,24 +0,0 @@
-#
-# Page elements. Base class.
-#
-class BaseElement
-  attr_accessor :context
-
-  def initialize(element_context)
-    raise element_context.to_s unless element_context.is_a? ElementContext
-    @context = element_context
-    # Not sure why, but I'm seeing Chrome fail becase the context interface
-    # passed in isn't the same as the browser's interface.
-    # This only happens with click test cases, before the click, and
-    # only if that case isn't run first.
-    # The context we're passed is also an instance from as ChromeInterface,
-    # but a different instance.
-    #
-    # Here's the kludge workaround line:
-    @context.interface = $browser.interface
-  end
-
-  def this_css
-    @context.find_element(:css)
-  end
-end

data/lib/rutl/interface/elements/button.rb

@@ -1,10 +0,0 @@
-require 'rutl/interface/elements/base_element'
-require 'rutl/interface/elements/click_to_change_state_mixin'
-
-#
-# It's a button!
-#
-class Button < BaseElement
-  include ClickToChangeStateMixin
-  # def get, text - return button text; useful for text-changing buttons
-end

data/lib/rutl/interface/elements/checkbox.rb

@@ -1,8 +0,0 @@
-require 'rutl/interface/elements/base_element'
-
-#
-# Yes, a checkbox.
-#
-class Checkbox < BaseElement
-  # get and set? toggle?
-end

data/lib/rutl/interface/elements/click_to_change_state_mixin.rb

@@ -1,18 +0,0 @@
-#
-# Mix this in for things that change state when clicked.
-# The only things that wouldn't change state when clicked either
-# shouldn't be clicked or are just annoying.
-#
-module ClickToChangeStateMixin
-  def click
-    # Screenshot before clicking. Is this really necessary?
-    @context.interface.camera.screenshot
-    this_css.click
-    # returns the page it found
-    result = @context.interface.wait_for_transition(@context.destinations)
-    # And after clicking and going to new state. This seems more needed
-    # because we want to see where we went.
-    @context.interface.camera.screenshot
-    result
-  end
-end

data/lib/rutl/interface/elements/element_context.rb

@@ -1,29 +0,0 @@
-#
-# The context passed around to all elements.
-# What they need to know outside of themselves to function.
-#
-class ElementContext
-  attr_accessor :destinations
-  attr_accessor :interface
-  attr_accessor :selectors
-
-  def initialize(destinations: nil, interface: nil, selectors: [])
-    unless destinations.nil? || destinations.class == Array
-      # Should check each destination to make sure it's a Page or a _____, too.
-      raise 'destination must be an Array of destinations or nil.'
-    end
-    @destinations = destinations || []
-    unless interface.nil? || interface.class.ancestors.include?(BaseInterface)
-      raise "#{interface.class}: #{interface} must be a *Interface class."
-    end
-    @interface = interface
-    @selectors = selectors
-  end
-
-  def find_element(type)
-    # @interface.driver.find_element(type, @selectors[type])
-    # Should be this, but apparently @interface.driver is being overwritten
-    # (or not written to) and it doesn't work. Using $browser does. :-(
-    $browser.interface.driver.find_element(type, @selectors[type])
-  end
-end

data/lib/rutl/interface/elements/link.rb

@@ -1,11 +0,0 @@
-require 'rutl/interface/elements/base_element'
-require 'rutl/interface/elements/click_to_change_state_mixin'
-
-#
-# Link, of course.
-#
-class Link < BaseElement
-  include ClickToChangeStateMixin
-  # text, url - get what they say
-  # should there be a 'get' - what would it get?
-end

data/lib/rutl/interface/elements/string_reader_writer_mixin.rb

@@ -1,66 +0,0 @@
-#
-# Implement String stuff in a mixin.
-# TODO: Not finished yet. Must be able to
-#
-module StringReaderWriterMixin
-  # Override BaseElement's normal initialize method.
-  def initialize(element_context, input_value = nil)
-    raise element_context.to_s unless element_context.is_a? ElementContext
-    @context = element_context
-    set input_value unless input_value.nil?
-  end
-
-  # I could cut set() and only foo_text= if I change this.
-  # The problem I'm running into is not having the driver in
-  # base element to do this_css calls. So I have to change the way
-  # drivers are passed into everything or initially have them everywhere,
-  # which means rewriting chosen drivers or changing page load.
-  # Ick.
-  def set(string)
-    clear
-    this_css.send_keys(string)
-  end
-  alias text= set
-  alias value= set
-
-  def get
-    this_css.attribute(:value)
-  end
-  alias text get
-  alias value get
-  alias to_s get
-
-  def clear
-    this_css.clear
-    get
-  end
-
-  def eql?(other)
-    other == get
-  end
-  alias == eql?
-
-  def send_keys(string)
-    this_css.send_keys(string)
-    get
-  end
-
-  def method_missing(method, *args, &block)
-    # RuboCop complains unless I fall back to super here
-    # even though that's pretty meaningless. Oh, well, it's harmless.
-    super unless get.respond_to?(method)
-    if args.empty?
-      get.send(method)
-    else
-      get.send(method, *args, &block)
-    end
-  end
-
-  def respond_to_missing?(method, flag)
-    get.respond_to?(method, flag)
-  end
-
-  #
-  # TODO: Fall through to String methods?
-  #
-end

data/lib/rutl/interface/elements/text.rb

@@ -1,10 +0,0 @@
-require 'rutl/interface/elements/base_element'
-require 'rutl/interface/elements/string_reader_writer_mixin.rb'
-
-#
-# I'm using the text element for all text-like things. Passowrds, too.
-# TODO: Also have a reader only class with StringReaderMixin for labels?
-#
-class Text < BaseElement
-  include StringReaderWriterMixin
-end

data/lib/rutl/screencam.rb

@@ -1,71 +0,0 @@
-require 'fileutils'
-#
-# class to take photos of the screen (and diff them?)
-#
-class ScreenCam
-  def guard
-    # When running headless, Selenium seems not to drop screenshots.
-    # So that makes this safe in places like Travis.
-    #
-    # We still need to guard against NullDriver or we'll to to screencap
-    # it when we're running head-fully.
-    #
-    # Will there be others?
-    @driver.is_a? NullDriver
-  end
-
-  def initialize(driver, base_name: '')
-    @counter = 0
-    @driver = driver
-    return if guard
-    @base_name = base_name
-    @dir = File.join(RUTL::SCREENSHOTS, base_name)
-    FileUtils.mkdir_p @dir
-  end
-
-  def shoot(path = nil)
-    return if guard
-    # Magic path is used for all auto-screenshots.
-    name = path || magic_path
-
-    FileUtils.mkdir_p @dir
-    file = File.join(@dir, pathify(name))
-    @driver.save_screenshot(file)
-  end
-  alias screenshot shoot
-
-  def clean_dir(dir)
-    FileUtils.rm_rf dir
-    FileUtils.mkdir_p dir
-  end
-
-  def counter
-    @counter += 1
-    # In the unlikely even that we have > 9 screenshots in a test case,
-    # format the counter to be two digits, zero padded.
-    format('%02d', @counter)
-  end
-
-  def magic_path
-    if defined? RSpec
-      RSpec.current_example.metadata[:full_description].to_s
-    else
-      # TODO: The behavior for non-RSpec users is ugly and broken.
-      # Each new test case will start taking numbered "auto-screenshot" pngs.
-      # And the next test case will overwrite them. Even if they didn't
-      # overwrite, I don't know how to correllate tests w/ scrrenshots. I'm
-      # leaving this broken for now.
-      # You can still tell it to take your own named screenshots whenever you
-      # like, of course.
-      'auto-screenshot'
-    end
-  end
-
-  def pathify(path)
-    # Replace any of these with an underscore:
-    # space, octothorpe, slash, backslash, colon, period
-    name = path.gsub(%r{[ \#\/\\\:\.]}, '_')
-    # Also insert a counter and make sure we end with .png.
-    name.sub(/.png$/, '') + '_' + counter + '.png'
-  end
-end