rutl 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f2590f32dfe005e1508e0e88f3faa3a840173da6bf67313f0e951642c13e611
-  data.tar.gz: 500cbd32f70149497bd3a1decdccb21678f2e516d3b97e96aeaa4a2d5abfc72b
+  metadata.gz: 21fa6d406b33dee3134e1cf6da770e4f51434664d55d109b19858290ec5f0776
+  data.tar.gz: ab14d6f097caa9bbdc888ca8409c711fed65da87129bbcb03f96fa265aa5df34
 SHA512:
-  metadata.gz: f312505641be60572b85da6fbe890a49be75af82f5c61c5f484b39e11596706f3c3b04c699a3759da8774227d1f86c1c18502ed8d765fe389a04c9c7c7a88505
-  data.tar.gz: f0dd36b84da17dc6a4db7d61ae973f024a8f940ef408a27be3d79422e5a11a7989b178ce549bc6a3e4052fc5fd1971c93522c0ebb6479776fa75b8e8644ad19e
+  metadata.gz: 5c81506c59bc5224d50928351455241d83123cfb7d2ff3a8383b0aad7e0914ede6f20128e5dbe34d87743c0575ac33972b517a2506f51292a32dad64b29abc03
+  data.tar.gz: 2e99c3d93ae8cd9af232ffc26d214866f649cd2d295a553818e835e6e7b0ee3abd4f805741fefbfd85a910251451358309435fe3c6bd4bdc4419868cc667203c

data/.rubocop.yml

@@ -40,7 +40,7 @@ Style/BracesAroundHashParameters:
 # And BasePage does @@loaded_pages.
 Style/ClassVars:
   Exclude:
-    - 'lib/rutl/driver/null_driver_page_element.rb'
+    - 'lib/rutl/null_driver/null_element.rb'
     - 'lib/rutl/base_page.rb'
 
 # Rubocop flags lots of things as useless assignment when they're actually

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-07 12:55:41 -0700 using RuboCop version 0.56.0.
+# on 2018-06-07 20:55:18 -0700 using RuboCop version 0.56.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,19 +11,26 @@
 Metrics/MethodLength:
   Max: 11
 
+# Offense count: 2
+Style/ClassVars:
+  Exclude:
+    - 'lib/rutl/driver/null_driver_page_element.rb'
+    - 'lib/rutl/base_page.rb'
+    - 'lib/rutl/null_driver/null_element.rb'
+
 # Offense count: 4
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
     - 'lib/rutl/browser.rb'
-    - 'lib/rutl/interface/elements/element.rb'
-    - 'lib/rutl/interface/elements/element_context.rb'
-    - 'lib/rutl/interface/null_interface.rb'
+    - 'lib/rutl/element/element.rb'
+    - 'lib/rutl/element/element_context.rb'
+    - 'lib/rutl/interface/null.rb'
 
 # Offense count: 4
 Style/MethodMissingSuper:
   Exclude:
     - 'lib/rutl/browser.rb'
-    - 'lib/rutl/interface/base_interface.rb'
-    - 'lib/rutl/interface/elements/element.rb'
+    - 'lib/rutl/element/element.rb'
+    - 'lib/rutl/interface/base.rb'
     - 'lib/rutl/page.rb'

data/lib/rutl/browser.rb

@@ -38,8 +38,8 @@ module RUTL
     private
 
     def load_interface(type)
-      require "rutl/interface/#{type}_interface"
-      klass = "RUTL::#{type.to_s.capitalize}Interface"
+      require "rutl/interface/#{type}"
+      klass = "RUTL::Interface::#{type.to_s.capitalize}"
       Object.const_get(klass).new
     end
 

data/lib/rutl/camera.rb

@@ -20,7 +20,7 @@ module RUTL
       @counter = 0
       @driver = driver
       return if guard
-      @base_name = base_name.sub('RUTL::', '')
+      @base_name = base_name.sub('::', '')
       @dir = File.join(RUTL::SCREENSHOTS, @base_name)
       FileUtils.mkdir_p @dir
     end

data/lib/rutl/element/element.rb

@@ -13,8 +13,8 @@ module RUTL
         # 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.
+        # The context we're passed is also an instance from as
+        # RUTL::Interface::Chrome, but a different instance.
         #
         # Here's the kludge workaround line:
         @context.interface = $browser.interface

data/lib/rutl/element/element_context.rb

@@ -1,38 +1,40 @@
 module RUTL
   module Element
-  #
-  # The context passed around to all elements.
-  # What they need to know outside of themselves to function.
-  #
-  class ElementContext
-    # Nil. Or an Array. One would hope an Array of states. But I'm not checking.
-    attr_accessor :destinations
-    # Nil. Or a RUTL::BaseInterface.
-    attr_accessor :interface
-    # An Arrray, maybe empty and maybe an array of selectors.
-    # TODO: This should be a hash.
-    attr_accessor :selectors
+    #
+    # The context passed around to all elements.
+    # What they need to know outside of themselves to function.
+    #
+    class ElementContext
+      # Nil. Or an Array. One would hope an Array of states.
+      # But I'm not checking.
+      attr_accessor :destinations
+      # Nil. Or a RUTL::Interface::Base.
+      attr_accessor :interface
+      # An Arrray, maybe empty and maybe an array of selectors.
+      # TODO: This should be a hash.
+      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.'
+      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.is_a?(RUTL::Interface::Base)
+          raise "#{interface.class}: #{interface} " \
+                'must be an Interface::* class.'
+        end
+        @interface = interface
+        @selectors = selectors
       end
-      @destinations = destinations || []
-      unless interface.nil? || interface.is_a?(RUTL::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])
+      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
   end
 end
-end

data/lib/rutl/interface/base.rb

@@ -0,0 +1,93 @@
+require 'utilities'
+require 'rutl/camera'
+
+module RUTL
+  module Interface
+    #
+    # I might need to consider renaming these.
+    # The *interface classes lie between Browser
+    # and the webdriver-level classes.
+    #
+    class Base
+      include Utilities
+
+      # RUTL::Driver
+      attr_accessor :driver
+
+      # RUTL::Camera
+      attr_accessor :camera
+
+      # Array of all RUTL::Page classes
+      attr_accessor :pages
+
+      def initialize
+        raise 'Child interface class must set @driver.' if @driver.nil?
+        # base_name avoids collisions when unning the same tests with
+        # different browsers.
+        name = self.class.to_s.sub('RUTL::Interface', '')
+        @camera = Camera.new(@driver, base_name: name)
+      end
+
+      # Attempts to navigate to the page.
+      # Takes screenshot if successful.
+      def goto(page)
+        raise 'expect Page class' unless page?(page)
+        find_page(page).go_to_here
+        @camera.screenshot
+      end
+
+      # Should define in children; raises here.
+      # Should return the current page class.
+      def current_page
+        raise 'define in child classes'
+      end
+
+      def method_missing(method, *args, &block)
+        if args.empty?
+          current_page.send(method)
+        else
+          current_page.send(method, *args, &block)
+        end
+      end
+
+      # TODO: Is this needed? I not only find the page but also make sure the
+      # urls match. Even though that's what finding pages means?
+      def find_state(target_states)
+        target_states.each do |state|
+          next unless state.url == current_page.url
+          page = find_page(state)
+          return page if page.loaded?
+        end
+        false
+      end
+
+      # Attempts to find page by class or url.
+      def find_page(page)
+        @pages.each do |p|
+          return p if page?(page) && p.class == page
+          return p if String == page.class && page == p.url
+        end
+        raise "Page \"#{page}\" not found in pages #{@pages}"
+      end
+
+      # Calls the polling utility mathod await() with a lambda trying to
+      # find the next state, probably a Page class.
+      def wait_for_transition(target_states)
+        #
+        # TODO: Should also see if there are other things to wait for.
+        # I don't think this is doing page load time.
+        #
+        await -> { find_state target_states }
+      end
+
+      def respond_to_missing?(*args)
+        # This can't be right. Figure it out later.
+        current_page.respond_to?(*args)
+      end
+
+      def quit
+        @driver.quit
+      end
+    end
+  end
+end

data/lib/rutl/interface/chrome.rb

@@ -0,0 +1,36 @@
+require 'selenium-webdriver'
+require 'rutl/interface/base'
+
+module RUTL
+  module Interface
+    #
+    # Small interface for Chrome browser.
+    #
+    class Chrome < Base
+      # 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
+      # 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
+      end
+    end
+  end
+end

data/lib/rutl/interface/firefox.rb

@@ -0,0 +1,29 @@
+require 'selenium-webdriver'
+require 'rutl/interface/base'
+
+module RUTL
+  module Interface
+    #
+    # Small interface for Chrome browser.
+    #
+    class Firefox < Base
+      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
+      end
+    end
+  end
+end

data/lib/rutl/interface/null.rb

@@ -0,0 +1,35 @@
+require 'rutl/interface/base'
+
+module RUTL
+  module Interface
+    #
+    # Interface-level code for fake browser.
+    #
+    class Null < Base
+      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
+
+      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
+      end
+    end
+  end
+end

data/lib/rutl/null_driver/null_element.rb

@@ -49,8 +49,7 @@ module RUTL
       # Placeholder - NOP
       # Called by RUTL::Element::ClickToChangeStateMixin like
       # Selenium driver.click
-      def click
-      end
+      def click; end
     end
   end
 end

data/lib/rutl/page.rb

@@ -84,8 +84,8 @@ module RUTL
     def method_missing(element, *args, &_block)
       name, selectors, rest = args
       context = RUTL::Element::ElementContext.new(destinations: rest,
-                                   interface: @interface,
-                                   selectors: selectors)
+                                                  interface: @interface,
+                                                  selectors: selectors)
       case element
       when /button/, /checkbox/, /element/, /link/
         add_method(name: name, context: context, klass: element)

data/lib/rutl/version.rb

@@ -1,3 +1,3 @@
 module RUTL
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rutl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Drew Cooper
@@ -198,10 +198,10 @@ files:
 - lib/rutl/element/link.rb
 - lib/rutl/element/string_reader_writer_mixin.rb
 - lib/rutl/element/text.rb
-- lib/rutl/interface/base_interface.rb
-- lib/rutl/interface/chrome_interface.rb
-- lib/rutl/interface/firefox_interface.rb
-- lib/rutl/interface/null_interface.rb
+- lib/rutl/interface/base.rb
+- lib/rutl/interface/chrome.rb
+- lib/rutl/interface/firefox.rb
+- lib/rutl/interface/null.rb
 - lib/rutl/null_driver/null_driver.rb
 - lib/rutl/null_driver/null_element.rb
 - lib/rutl/page.rb

data/lib/rutl/interface/base_interface.rb

@@ -1,90 +0,0 @@
-require 'utilities'
-require 'rutl/camera'
-
-module RUTL
-  #
-  # I might need to consider renaming these.
-  # The *interface classes lie between Browser and the webdriver-level classes.
-  #
-  class BaseInterface
-    include Utilities
-
-    # RUTL::Driver
-    attr_accessor :driver
-
-    # RUTL::Camera
-    attr_accessor :camera
-
-    # Array of all RUTL::Page classes
-    attr_accessor :pages
-
-    def initialize
-      raise 'Child interface class must set @driver.' if @driver.nil?
-      # base_name avoids collisions when unning the same tests with
-      # different browsers.
-      name = self.class.to_s.sub('RUTL::Interface', '')
-      @camera = Camera.new(@driver, base_name: name)
-    end
-
-    # Attempts to navigate to the page.
-    # Takes screenshot if successful.
-    def goto(page)
-      raise 'expect Page class' unless page?(page)
-      find_page(page).go_to_here
-      @camera.screenshot
-    end
-
-    # Should define in children; raises here.
-    # Should return the current page class.
-    def current_page
-      raise 'define in child classes'
-    end
-
-    def method_missing(method, *args, &block)
-      if args.empty?
-        current_page.send(method)
-      else
-        current_page.send(method, *args, &block)
-      end
-    end
-
-    # TODO: Is this needed? I not only find the page but also make sure the
-    # urls match. Even though that's what finding pages means?
-    def find_state(target_states)
-      target_states.each do |state|
-        next unless state.url == current_page.url
-        page = find_page(state)
-        return page if page.loaded?
-      end
-      false
-    end
-
-    # Attempts to find page by class or url.
-    def find_page(page)
-      @pages.each do |p|
-        return p if page?(page) && p.class == page
-        return p if String == page.class && page == p.url
-      end
-      raise "Page \"#{page}\" not found in pages #{@pages}"
-    end
-
-    # Calls the polling utility mathod await() with a lambda trying to
-    # find the next state, probably a Page class.
-    def wait_for_transition(target_states)
-      #
-      # TODO: Should also see if there are other things to wait for.
-      # I don't think this is doing page load time.
-      #
-      await -> { find_state target_states }
-    end
-
-    def respond_to_missing?(*args)
-      # This can't be right. Figure it out later.
-      current_page.respond_to?(*args)
-    end
-
-    def quit
-      @driver.quit
-    end
-  end
-end

data/lib/rutl/interface/chrome_interface.rb

@@ -1,34 +0,0 @@
-require 'selenium-webdriver'
-require 'rutl/interface/base_interface'
-
-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
-    # 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
-    end
-  end
-end

data/lib/rutl/interface/firefox_interface.rb

@@ -1,27 +0,0 @@
-require 'selenium-webdriver'
-require 'rutl/interface/base_interface'
-
-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
-    end
-  end
-end

data/lib/rutl/interface/null_interface.rb

@@ -1,33 +0,0 @@
-require 'rutl/interface/base_interface'
-
-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
-
-    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
-    end
-  end
-end