rutl 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03966911ea3475762f121b4735aaee43a66af675c6b5baa255e329810c5fd890'
-  data.tar.gz: 4fbc7ec877d27b7daddae7f02c5b35396d9b6a5f59ffee90a5e4a29896627e1c
+  metadata.gz: 67625dcf7a3007342c0ea59bedc973fb833ff74ffd41eec945b0c2dd6f1022ef
+  data.tar.gz: 22f30517ae2fc0f2c33263db4443285a04f12d212174a7519f0bc58b07006283
 SHA512:
-  metadata.gz: 1cfe7eecf5fb7ab352d10408412835b827b7cb276959efeac9085a538d008bd8a829ad468b158135353b85c4a9277a6af9cab5eae200932667c10ce425c6e2e5
-  data.tar.gz: ab287a5457fd4b3fe81ed869b3316f3165c1f97fbd92c3af04c42a935366488911f5e0b51d335c6c89621817ada69d766eec157a00f8db0317d1f7271475d095
+  metadata.gz: 55d5a134ee68df90af1621f591852cba3a4fa362c3bd37fee884b913826ea2847c9784a786d1dc5478f4b5390a82acd2138263cc304afd2a91158ccee32423ae
+  data.tar.gz: d0600c7d541a0a226e635d94421d899dff5998a386decd0b71efad990e9ef4a8f36f8f68708991af6cceb5926c85aaee47fd98fd9d8191d412833407d1b41dca

data/.circleci/config.yml

@@ -7,7 +7,8 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
+       - image: circleci/ruby:2.5.1-stretch-node-browsers
+       #- image: circleci/ruby:2.4.1-node-browsers
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -71,4 +72,3 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
-          

data/.rubocop.yml

@@ -42,3 +42,10 @@ Style/ClassVars:
   Exclude:
     - 'lib/rutl/driver/null_driver_page_element.rb'
     - 'lib/rutl/base_page.rb'
+
+# Rubocop flags lots of things as useless assignment when they're actually
+# magic methods. Maybe this means I'm not handling respond_to_missing
+# correctly. In fact, that seems likely.
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/*_spec.rb'

data/.rubocop_todo.yml

@@ -1,23 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-04 00:16:13 -0700 using RuboCop version 0.56.0.
+# on 2018-06-07 12:55:41 -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
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
 # Offense count: 4
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
     - 'lib/rutl/browser.rb'
-    - 'lib/rutl/interface/elements/base_element.rb'
+    - 'lib/rutl/interface/elements/element.rb'
     - 'lib/rutl/interface/elements/element_context.rb'
     - 'lib/rutl/interface/null_interface.rb'
 
-# Offense count: 3
+# Offense count: 4
 Style/MethodMissingSuper:
   Exclude:
-    - 'lib/rutl/base_page.rb'
     - 'lib/rutl/browser.rb'
     - 'lib/rutl/interface/base_interface.rb'
+    - 'lib/rutl/interface/elements/element.rb'
+    - 'lib/rutl/page.rb'

data/.travis.yml

@@ -5,3 +5,4 @@ language: ruby
 rvm:
   - 2.3.1
 before_install: gem install bundler -v 1.13.6
+script: bundle exec rspec

data/README.md

@@ -169,8 +169,7 @@ your tests screenshot anyway, just less magic.
 
 ## Roadmap
 Coming up soon in almost no order:
-* Handle error pages/partials.
-* Auto-screenshot on errors. Error destinations. Navigation errors. Unexpected exceptions?
+* Handle other errors. Auto-screenshot on errors. Navigation errors. Unexpected exceptions?
 * A test framework should have better tests.
 * Diff screenshots. Make this smart so we don't have to be experts.
 * Put more info in this readme.

data/lib/rspec/rutl_matchers.rb

@@ -1,8 +1,11 @@
+require 'utilities'
 #
 # Additional RSpec matchers specific to this framework go here.
 #
+
+# Is it the expected page?
 RSpec::Matchers.define :be_page do |expected|
   match do |actual|
-    actual.is_a?(expected) && expected.ancestors.include?(BasePage)
+    actual.is_a?(expected) && page?(expected)
   end
 end

data/lib/rutl.rb

@@ -9,13 +9,13 @@ module RUTL
   # Should define RUTL::PAGES directory for your code
   # or set ENV['RUTL_PAGES']
   # or Browser intialize will raise.
-  PAGES = nil
+  # PAGES = nil
 
   # If this RUTL::SCREENSHOT_DIR or ENV['SCREENSHOT_DIR']
   # or Browser initialize is set, we take screenshots.
-  SCREENSHOTS = nil
+  # SCREENSHOTS = nil
 
   # This one is for diffing against.
   # RUTL::KNOWN_GOOD_SCREENSHOTS
-  REFERENCE_SCREENSHOTS = nil
+  # REFERENCE_SCREENSHOTS = nil
 end

data/lib/rutl/browser.rb

@@ -1,65 +1,70 @@
-require 'rutl/utilities'
-require 'rutl/base_page'
+require 'utilities'
+require 'rutl/page'
 
-#
-# Currently called Browser, this top-level class controls a browser and
-# a fake browser. It will soon call into apps, at which point I need to
-# rethink this naming convention.
-#
-class Browser
-  include Utilities
+module RUTL
+  #
+  # Currently called Browser, this top-level class controls a browser and
+  # a fake browser. It will soon call into apps, at which point I need to
+  # rethink this naming convention.
+  #
+  class Browser
+    include Utilities
 
-  attr_reader :interface
+    attr_reader :interface
 
-  def initialize(type:, rutl_pages: RUTL::PAGES || ENV['RUTL_PAGES'])
-    if rutl_pages.nil? || rutl_pages.empty?
-      raise "Set RUTL::PAGES or ENV['RUTL_PAGES'] or pass dir as rutl_pages:"
+    def initialize(type:, rutl_pages: RUTL::PAGES || ENV['RUTL_PAGES'])
+      if rutl_pages.nil? || rutl_pages.empty?
+        raise "Set RUTL::PAGES or ENV['RUTL_PAGES'] or pass dir as rutl_pages:"
+      end
+      # This is kind of evil. Figure out how to ditch the $ variable.
+      $browser = self
+      @interface = nil # TODO: Why this line? Do I need to do this?
+      @interface = load_interface(type)
+      @interface.pages = load_pages(dir: rutl_pages)
     end
-    # This is kind of evil. Figure out how to ditch the $ variable.
-    $browser = self
-    @interface = nil
-    @interface = load_interface(type)
-    @interface.pages = load_pages(dir: rutl_pages)
-  end
-
-  def load_interface(type)
-    require "rutl/interface/#{type}_interface"
-    klass = "#{type.to_s.capitalize}Interface"
-    Object.const_get(klass).new
-  end
 
-  # Ugly. Requires files for page objects. Returns array of class names to load.
-  def require_pages(dir: 'spec/pages')
-    names = []
-    Dir["#{dir}/*"].each do |file|
-      require "rutl/../../#{file}"
-      File.open(file).each do |line|
-        bingo = line.match(/class (.*) < BasePage/)
-        names << bingo[1] if bingo && bingo[1]
+    def method_missing(method, *args, &block)
+      if args.empty?
+        @interface.send(method)
+      else
+        @interface.send(method, *args, &block)
       end
     end
-    names
-  end
 
-  def load_pages(*)
-    pages = []
-    require_pages.each do |klass|
-      # Don't have @interface set yet.
-      # That would have been the param to new, :interface.
-      pages << Object.const_get(klass).new(@interface)
+    def respond_to_missing?(*args)
+      @interface.respond_to?(*args)
     end
-    pages
-  end
 
-  def method_missing(method, *args, &block)
-    if args.empty?
-      @interface.send(method)
-    else
-      @interface.send(method, *args, &block)
+    private
+
+    def load_interface(type)
+      require "rutl/interface/#{type}_interface"
+      klass = "RUTL::#{type.to_s.capitalize}Interface"
+      Object.const_get(klass).new
+    end
+
+    def load_pages(*)
+      pages = []
+      require_pages.each do |klass|
+        # Don't have @interface set yet.
+        # That would have been the param to new, :interface.
+        pages << Object.const_get(klass).new(@interface)
+      end
+      pages
     end
-  end
 
-  def respond_to_missing?(*args)
-    @interface.respond_to?(*args)
+    # Ugly. Requires files for page objects.
+    # Returns array of class names to load.
+    def require_pages(dir: 'spec/pages')
+      names = []
+      Dir["#{dir}/*"].each do |file|
+        require "rutl/../../#{file}"
+        File.open(file).each do |line|
+          bingo = line.match(/class (.*) < RUTL::Page/)
+          names << bingo[1] if bingo && bingo[1]
+        end
+      end
+      names
+    end
   end
 end

data/lib/rutl/camera.rb

@@ -0,0 +1,74 @@
+require 'fileutils'
+
+module RUTL
+  #
+  #   class to take photos of the screen (and diff them?)
+  #
+  class Camera
+    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? RUTL::NullDriver
+    end
+
+    def initialize(driver, base_name: '')
+      @counter = 0
+      @driver = driver
+      return if guard
+      @base_name = base_name.sub('RUTL::', '')
+      @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
+end

data/lib/rutl/interface/base_interface.rb

@@ -1,77 +1,90 @@
-require 'rutl/utilities'
-require 'rutl/screencam'
-#
-# I might need to consider renaming these.
-# The *interface classes lie between Browser and the webdriver-level classes.
-#
-class BaseInterface
-  include Utilities
+require 'utilities'
+require 'rutl/camera'
 
-  attr_accessor :driver
-  attr_reader :camera
-  attr_accessor :pages
+module RUTL
+  #
+  # I might need to consider renaming these.
+  # The *interface classes lie between Browser and the webdriver-level classes.
+  #
+  class BaseInterface
+    include Utilities
 
-  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('Interface', '')
-    @camera = ScreenCam.new(@driver, base_name: name)
-  end
+    # RUTL::Driver
+    attr_accessor :driver
 
-  def goto(page)
-    raise 'expect Page class' unless page.ancestors.include?(BasePage)
-    find_page(page).go_to_here
-    @camera.screenshot
-  end
+    # RUTL::Camera
+    attr_accessor :camera
 
-  def current_page
-    raise 'define in child classes'
-  end
+    # Array of all RUTL::Page classes
+    attr_accessor :pages
 
-  def method_missing(method, *args, &block)
-    if args.empty?
-      current_page.send(method)
-    else
-      current_page.send(method, *args, &block)
+    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
-  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?(@driver)
+    # 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
-    false
-  end
 
-  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
+    # Should define in children; raises here.
+    # Should return the current page class.
+    def current_page
+      raise 'define in child classes'
     end
-    raise "Page \"#{page}\" not found in pages #{@pages}"
-  end
 
-  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 method_missing(method, *args, &block)
+      if args.empty?
+        current_page.send(method)
+      else
+        current_page.send(method, *args, &block)
+      end
+    end
 
-  def respond_to_missing?(*args)
-    # This can't be right. Figure it out later.
-    current_page.respond_to?(*args)
-  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
-    # Maybe I'm reusing pages from @pages?
-    # @pages = []
+    def quit
+      @driver.quit
+    end
   end
 end