rutl 0.3.0 → 0.4.0

data/lib/rutl/interface/chrome_interface.rb

@@ -1,32 +1,34 @@
 require 'selenium-webdriver'
 require 'rutl/interface/base_interface'
 
-#
-# Small interface for Chrome browser.
-#
-class ChromeInterface < BaseInterface
-  # rubocop:disable Metrics/MethodLength
-  def initialize
-    @logged_in = true
-    options = Selenium::WebDriver::Chrome::Options.new
-    options.add_argument('--ignore-certificate-errors')
-    options.add_argument('--disable-popup-blocking')
-    options.add_argument('--disable-translate')
-    # Run headless on TravisCI
-    if ENV['TRAVIS'] == 'true'
-      options.add_argument('--disable-gpu')
-      options.add_argument('--headless ')
-      options.add_argument('--no-sandbox')
+module RUTL
+  #
+  # Small interface for Chrome browser.
+  #
+  class ChromeInterface < BaseInterface
+    # rubocop:disable Metrics/MethodLength
+    def initialize
+      @logged_in = true
+      options = Selenium::WebDriver::Chrome::Options.new
+      options.add_argument('--ignore-certificate-errors')
+      options.add_argument('--disable-popup-blocking')
+      options.add_argument('--disable-translate')
+      # Run headless on TravisCI
+      if ENV['TRAVIS'] == 'true'
+        options.add_argument('--disable-gpu')
+        options.add_argument('--headless ')
+        options.add_argument('--no-sandbox')
+      end
+      @driver = Selenium::WebDriver.for :chrome, options: options
+      super
     end
-    @driver = Selenium::WebDriver.for :chrome, options: options
-    super
-  end
-  # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength
 
-  def current_page
-    url = @driver.current_url
-    page = find_page(url)
-    raise "PAGE NOT FOUND: #{url}, PAGES: #{@pages}" unless page
-    page
+    def current_page
+      url = @driver.current_url
+      page = find_page(url)
+      raise "PAGE NOT FOUND: #{url}, PAGES: #{@pages}" unless page
+      page
+    end
   end
 end

data/lib/rutl/interface/firefox_interface.rb

@@ -1,25 +1,27 @@
 require 'selenium-webdriver'
 require 'rutl/interface/base_interface'
 
-#
-# Small interface for Chrome browser.
-#
-class FirefoxInterface < BaseInterface
-  def initialize
-    @logged_in = true
-    options = Selenium::WebDriver::Firefox::Options.new
-    options.add_argument('--ignore-certificate-errors')
-    options.add_argument('--disable-popup-blocking')
-    options.add_argument('--disable-translate')
-    options.add_argument('--headless') if ENV['TRAVIS'] == 'true'
-    @driver = Selenium::WebDriver.for :firefox, options: options
-    super
-  end
+module RUTL
+  #
+  # Small interface for Chrome browser.
+  #
+  class FirefoxInterface < BaseInterface
+    def initialize
+      @logged_in = true
+      options = Selenium::WebDriver::Firefox::Options.new
+      options.add_argument('--ignore-certificate-errors')
+      options.add_argument('--disable-popup-blocking')
+      options.add_argument('--disable-translate')
+      options.add_argument('--headless') if ENV['TRAVIS'] == 'true'
+      @driver = Selenium::WebDriver.for :firefox, options: options
+      super
+    end
 
-  def current_page
-    url = @driver.current_url
-    page = find_page(url)
-    raise "PAGE NOT FOUND: #{url}, PAGES: #{@pages}" unless page
-    page
+    def current_page
+      url = @driver.current_url
+      page = find_page(url)
+      raise "PAGE NOT FOUND: #{url}, PAGES: #{@pages}" unless page
+      page
+    end
   end
 end

data/lib/rutl/interface/null_interface.rb

@@ -1,31 +1,33 @@
 require 'rutl/interface/base_interface'
 
-#
-# Interface-level code for fake browser.
-#
-class NullInterface < BaseInterface
-  def initialize
-    context = ElementContext.new(destinations: nil,
-                                 interface: self,
-                                 selectors: [])
-    @driver = NullDriver.new(context)
-    super
-  end
+module RUTL
+  #
+  # Interface-level code for fake browser.
+  #
+  class NullInterface < BaseInterface
+    def initialize
+      context = RUTL::Element::ElementContext.new(destinations: nil,
+                                   interface: self,
+                                   selectors: [])
+      @driver = NullDriver.new(context)
+      super
+    end
 
-  # The null driver needs to talk to the null interface.
-  # Other driver/interface relations are not like this.
-  attr_writer :current_page
+    # The null driver needs to talk to the null interface.
+    # Other driver/interface relations are not like this.
+    attr_writer :current_page
 
-  def current_page
-    # Default to @pages.first if not set?
-    # A browser can always check its current URL but the null driver can't.
-    @current_page ||= @pages.first
-  end
+    def current_page
+      # Default to @pages.first if not set?
+      # A browser can always check its current URL but the null driver can't.
+      @current_page ||= @pages.first
+    end
 
-  def wait_for_transition(destinations)
-    # TODO: Setting @current page didn't do it beacause that set
-    # context.interface.current_page and we wanted this in the browser.
-    @current_page = destinations.first.new(self)
-    $browser.current_page = @current_page
+    def wait_for_transition(destinations)
+      # TODO: Setting @current page didn't do it beacause that set
+      # context.interface.current_page and we wanted this in the browser.
+      @current_page = destinations.first.new(self)
+      $browser.current_page = @current_page
+    end
   end
 end

data/lib/rutl/null_driver/null_driver.rb

@@ -0,0 +1,42 @@
+require 'rutl/null_driver/null_element'
+
+module RUTL
+  #
+  # 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?(RUTL::Element::ElementContext)
+      @context = context
+    end
+
+    # Return a new one of these fake things so that it can be clicked
+    # ar written to or whatever.
+    def find_element(type, location)
+      context = RUTL::Element::ElementContext.new(interface: @context.interface)
+      RUTL::Element::NullElement.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 = RUTL::Element::ElementContext.new(interface: @context.interface)
+      NullDriver.new(context)
+    end
+
+    # Cheap second part to naviate.to(url) calls to look like real drivers.
+    def to(url)
+      result = @context.interface.find_page(url)
+      @context.interface.current_page = result
+      result.url
+    end
+
+    # Clean out the @@variables from NullElement.
+    # Other than this, this is a placeholder to match real drivers.
+    def quit
+      RUTL::Element::NullElement.clear_variables
+    end
+  end
+end

data/lib/rutl/null_driver/null_element.rb

@@ -0,0 +1,56 @@
+require 'rutl/element/element_context'
+
+module RUTL
+  module Element
+    #
+    # 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 NullElement
+      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
+
+      # Placeholder - NOP
+      # Called by RUTL::Element::ClickToChangeStateMixin like
+      # Selenium driver.click
+      def click
+      end
+    end
+  end
+end

data/lib/rutl/page.rb

@@ -0,0 +1,119 @@
+require 'rutl/element'
+require 'rutl/null_driver/null_driver'
+
+module RUTL
+  #
+  # Base page class. It's used to call the magical method_messing
+  # stuff to parse the page object files into actual objects.
+  #
+  class Page
+    # 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
+
+    # Intentially use a class variable to hald pages. Once they're all loaded
+    # they are all loaded for everyone.
+    # rubocop:disable Style/ClassVars
+    @@loaded_pages = []
+    # rubocop:enable Style/ClassVars
+
+    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 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?
+      url == @interface.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 a RUTL::Element::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("RUTL::Element::#{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
+    private :add_method
+    # 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 = RUTL::Element::ElementContext.new(destinations: rest,
+                                   interface: @interface,
+                                   selectors: selectors)
+      case element
+      when /button/, /checkbox/, /element/, /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/, /element/, /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 'TODO: BETTER ERROR MESSAGE, PLEASE. I AM SHOUTING!!!\n' \
+              '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
+end

data/lib/rutl/version.rb

@@ -1,3 +1,3 @@
 module RUTL
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/{rutl/utilities.rb → utilities.rb}

@@ -4,7 +4,7 @@
 module Utilities
   require 'timeout'
 
-  POLL_SLEEP_TIME = 0.1
+  POLL_SLEEP_TIME = 0.01
   DEFAULT_TIMEOUT = 5
 
   # The lambda passed to await should return false if thing not found
@@ -33,13 +33,9 @@ module Utilities
   end
 
   def page?(checkme)
-    checkme.ancestors.include?(BasePage)
+    checkme.ancestors.include?(RUTL::Page)
   rescue NoMethodError
     # This isn't a even a class. It's no page!
     false
   end
-
-  def raise_if_not_page(page)
-    raise "NOT A PAGE: #{page}. Ancestors: #{page.ancestors}" unless page?(page)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rutl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Drew Cooper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -187,26 +187,17 @@ files:
 - lib/rspec/default_rspec_to_browser.rb
 - lib/rspec/rutl_matchers.rb
 - lib/rutl.rb
-- lib/rutl/base_page.rb
 - lib/rutl/browser.rb
-- lib/rutl/driver/null_driver.rb
-- lib/rutl/driver/null_driver_page_element.rb
+- lib/rutl/camera.rb
 - lib/rutl/interface/base_interface.rb
 - lib/rutl/interface/chrome_interface.rb
-- lib/rutl/interface/elements.rb
-- lib/rutl/interface/elements/base_element.rb
-- lib/rutl/interface/elements/button.rb
-- lib/rutl/interface/elements/checkbox.rb
-- lib/rutl/interface/elements/click_to_change_state_mixin.rb
-- lib/rutl/interface/elements/element_context.rb
-- lib/rutl/interface/elements/link.rb
-- lib/rutl/interface/elements/string_reader_writer_mixin.rb
-- lib/rutl/interface/elements/text.rb
 - lib/rutl/interface/firefox_interface.rb
 - lib/rutl/interface/null_interface.rb
-- lib/rutl/screencam.rb
-- lib/rutl/utilities.rb
+- lib/rutl/null_driver/null_driver.rb
+- lib/rutl/null_driver/null_element.rb
+- lib/rutl/page.rb
 - lib/rutl/version.rb
+- lib/utilities.rb
 - rutl.gemspec
 homepage: https://github.com/drewcoo/rutl
 licenses: