rutl 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67625dcf7a3007342c0ea59bedc973fb833ff74ffd41eec945b0c2dd6f1022ef
-  data.tar.gz: 22f30517ae2fc0f2c33263db4443285a04f12d212174a7519f0bc58b07006283
+  metadata.gz: 1f2590f32dfe005e1508e0e88f3faa3a840173da6bf67313f0e951642c13e611
+  data.tar.gz: 500cbd32f70149497bd3a1decdccb21678f2e516d3b97e96aeaa4a2d5abfc72b
 SHA512:
-  metadata.gz: 55d5a134ee68df90af1621f591852cba3a4fa362c3bd37fee884b913826ea2847c9784a786d1dc5478f4b5390a82acd2138263cc304afd2a91158ccee32423ae
-  data.tar.gz: d0600c7d541a0a226e635d94421d899dff5998a386decd0b71efad990e9ef4a8f36f8f68708991af6cceb5926c85aaee47fd98fd9d8191d412833407d1b41dca
+  metadata.gz: f312505641be60572b85da6fbe890a49be75af82f5c61c5f484b39e11596706f3c3b04c699a3759da8774227d1f86c1c18502ed8d765fe389a04c9c7c7a88505
+  data.tar.gz: f0dd36b84da17dc6a4db7d61ae973f024a8f940ef408a27be3d79422e5a11a7989b178ce549bc6a3e4052fc5fd1971c93522c0ebb6479776fa75b8e8644ad19e

data/lib/rutl/element.rb

@@ -0,0 +1,6 @@
+require 'rutl/element/button'
+require 'rutl/element/checkbox'
+require 'rutl/element/element'
+require 'rutl/element/link'
+require 'rutl/element/text'
+require 'rutl/element/element_context'

data/lib/rutl/element/button.rb

@@ -0,0 +1,14 @@
+require 'rutl/element/element'
+require 'rutl/element/click_to_change_state_mixin'
+
+module RUTL
+  module Element
+    #
+    # It's a button!
+    #
+    class Button < Element
+      include ClickToChangeStateMixin
+      # def get, text - return button text; useful for text-changing buttons
+    end
+  end
+end

data/lib/rutl/element/checkbox.rb

@@ -0,0 +1,12 @@
+require 'rutl/element/element'
+
+module RUTL
+  module Element
+    #
+    # Yes, a checkbox.
+    #
+    class Checkbox < Element
+      # get and set? toggle? tbd.
+    end
+  end
+end

data/lib/rutl/element/click_to_change_state_mixin.rb

@@ -0,0 +1,24 @@
+module RUTL
+  module Element
+    #
+    # 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
+      # click does:
+      # * Screenshot before clicking. Is this really necessary?
+      # * Click.
+      # * Waits for transition to post-click state. (Polls until one reached.)
+      # * Screenshot again after the transition. This one is definitely needed.
+      # * Returns the state we transitioned to.
+      def click
+        @context.interface.camera.screenshot
+        this_css.click
+        result = @context.interface.wait_for_transition(@context.destinations)
+        @context.interface.camera.screenshot
+        result
+      end
+    end
+  end
+end

data/lib/rutl/element/element.rb

@@ -0,0 +1,51 @@
+module RUTL
+  module Element
+    #
+    # Page element base class.
+    #
+    class Element
+      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
+
+      # Returns the element at this css selector.
+      def this_css
+        @context.find_element(:css)
+      end
+
+      # Returns boolean, of course.
+      # Unlike the underlying Selenium library, I have .exists? because I may
+      # have a valid Element object for something that doesn't exist. Anymore.
+      # Or yet.
+      def exists?
+        this_css
+      rescue Selenium::WebDriver::Error::NoSuchElementError
+        false
+      end
+
+      def method_missing(method, *args, &block)
+        if args.empty?
+          this_css.send(method)
+        else
+          this_css.send(method, *args, &block)
+        end
+      end
+
+      def respond_to_missing?(*args)
+        this_css.respond_to?(*args)
+      end
+    end
+  end
+end

data/lib/rutl/element/element_context.rb

@@ -0,0 +1,38 @@
+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
+
+    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::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
+end
+end

data/lib/rutl/element/link.rb

@@ -0,0 +1,15 @@
+require 'rutl/element/element'
+require 'rutl/element/click_to_change_state_mixin'
+
+module RUTL
+  module Element
+    #
+    # Link, of course.
+    #
+    class Link < Element
+      include ClickToChangeStateMixin
+      # text, url - get what they say
+      # should there be a 'get' - what would it get?
+    end
+  end
+end

data/lib/rutl/element/string_reader_writer_mixin.rb

@@ -0,0 +1,77 @@
+module RUTL
+  module Element
+    #
+    # 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
+
+      # Return the String held by this element.
+      def get
+        this_css.attribute(:value)
+      end
+      alias text get
+      alias value get
+      alias to_s get
+
+      # Talk to the page and set the element's string to ''.
+      def clear
+        this_css.clear
+        get
+      end
+
+      # String value equals.
+      def eql?(other)
+        other == get
+      end
+      alias == eql?
+
+      # Sends these keystrokes without clearing the field.
+      # Returns the whole string in the field, including this input.
+      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? I already fall through to
+      # Selenium's Element methods in the Element class, so . . .
+      # it's complicated.
+      #
+    end
+  end
+end

data/lib/rutl/element/text.rb

@@ -0,0 +1,14 @@
+require 'rutl/element/element'
+require 'rutl/element/string_reader_writer_mixin.rb'
+
+module RUTL
+  module Element
+    #
+    # 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 < Element
+      include StringReaderWriterMixin
+    end
+  end
+end

data/lib/rutl/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rutl
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Drew Cooper
@@ -189,6 +189,15 @@ files:
 - lib/rutl.rb
 - lib/rutl/browser.rb
 - lib/rutl/camera.rb
+- lib/rutl/element.rb
+- lib/rutl/element/button.rb
+- lib/rutl/element/checkbox.rb
+- lib/rutl/element/click_to_change_state_mixin.rb
+- lib/rutl/element/element.rb
+- lib/rutl/element/element_context.rb
+- 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