rubium-ios 1.0.0.pre

data/lib/ui_automation/element_definitions.rb

@@ -0,0 +1,51 @@
+require 'active_support/core_ext/string/inflections'
+
+module UIAutomation
+  module ElementDefinitions
+    # Defines a method on an returns an element proxy.
+    #
+    # By default, the Javascript method name is underscored (e.g. textField => text_field)
+    # and the element returned is generic (UIAutomation::Element).
+    #
+    # @example Define a method 'text_field' that returns a proxy to <self>.textField()
+    #   has_element :textField
+    #
+    # @param [Hash] opts options for defining the method
+    # @option opts [Symbol] :as     Use a custom Ruby method name
+    # @option opts [Class]  :type   Return a specific UIAutomation::Element sub-class
+    # @api private
+    def has_element(js_method_name, opts={})
+      define_element_using(:element_proxy_for, js_method_name, opts)
+    end
+    
+    # Defines a method that returns an element array proxy.
+    #
+    # By default, the Javascript method name is underscored (e.g. textFields => text_fields)
+    # and the element array contains generic elements (UIAutomation::Element).
+    #
+    # @example Define a method 'text_fields' that returns a proxy to <self>.textFields() 
+    #   has_element :textFields
+    #
+    # @param [Hash] opts options for defining the method
+    # @option opts [Symbol] :as     Use a custom Ruby method name
+    # @option opts [Class]  :type   Return elements with this specific UIAutomation::Element sub-class
+    # @api private
+    def has_element_array(js_method_name, opts={})
+      define_element_using(:element_array_proxy_for, js_method_name, opts)
+    end
+    
+    private
+    
+    def define_element_using(proxy_method, js_method_name, opts)
+      method_name = opts[:as] || js_method_name.to_s.underscore
+
+      define_method(method_name) do
+        if opts[:type]
+          send(proxy_method, js_method_name, opts[:type])
+        else
+          send(proxy_method, js_method_name)
+        end
+      end
+    end
+  end
+end

data/lib/ui_automation/element_proxy_methods.rb

@@ -0,0 +1,43 @@
+module UIAutomation
+  module ElementProxyMethods
+    # Returns a new proxy object to a UIAElementArray. function_name must correspond to
+    # a function on the currently proxied object that returns an UIAElementArray as 
+    # defined by the Javascript API documentation.
+    #
+    # By default, the returned object will use UIAutomation::Element when creating
+    # proxies to any elements within its collection - pass a different UIAutomation::Element
+    # sub-class in as a second parameter if you want to use a specific type.
+    #
+    # @param [Symbol] function_name The javascript function that returns the proxied UIAElementArray.
+    # @param [Class] element_klass The class used as the proxy for each element in the array.
+    # @api private
+    def element_array_proxy_for(function_name, element_klass = UIAutomation::Element)
+      proxy_for(function_name, 
+        proxy_klass: UIAutomation::ElementArray, 
+        proxy_args: [element_klass, self, window]
+      )
+    end
+
+    # Similar to proxy_for() but returns an instance UIAutomation::Element by default.
+    #
+    # A specific UIAutomation::Element sub-class can be passed in as an optional second
+    # parameter.
+    #
+    # @raise [TypeError] if klass is not a UIAutomation::Element or sub-class.
+    # @param [Symbol] function_name The javascript function that returns the proxied UIAElement.
+    # @param [Class] klass The class to use for the returned proxy.
+    # @api private
+    def element_proxy_for(function_name, klass = UIAutomation::Element)
+      raise TypeError.new("Element type #{klass} is not a sub-class of UIAutomation::Element") unless (klass <= UIAutomation::Element)
+      
+      proxy_for(function_name, 
+        proxy_klass: klass, 
+        proxy_args: [self, window]
+      )
+    end
+  end
+  
+  class RemoteProxy
+    include ElementProxyMethods
+  end
+end

data/lib/ui_automation/keyboard.rb

@@ -0,0 +1,40 @@
+module UIAutomation
+  # A RemoteProxy to UIAKeyboard objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAKeyboardClassReference/
+  #
+  class Keyboard < Element
+    ### @!group Element Collections
+
+    # The keyboard's keys
+    has_element_array :keys
+
+    ### @!endgroup
+    
+    ### @!group Elements
+
+    # @return [UIAutomation::Element] the keyboard's done button
+    def done_button
+      buttons['Done']
+    end
+    
+    # @return [UIAutomation::Element] the keyboard's return button
+    def return_button
+      buttons['Return']
+    end
+
+    ### @!endgroup
+   
+    ### @!group Actions
+
+    # Types the given string by simulating key presses.
+    #
+    # @param [String] string the string to type
+    #
+    def type(string)
+      perform :typeString, string
+    end
+
+    ### @!endgroup
+  end
+end

data/lib/ui_automation/logger.rb

@@ -0,0 +1,43 @@
+module UIAutomation
+  # A RemoteProxy to UIALogger objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIALoggerClassReference/
+  #
+  class Logger < RemoteProxy
+    def self.logger(driver)
+      from_javascript(driver, 'UIALogger')
+    end
+    
+    def start(message)
+      perform :logStart, message
+    end
+    
+    def pass(message)
+      perform :logPass, message
+    end
+    
+    def fail(message)
+      perform :logFail, message
+    end
+    
+    def issue(message)
+      perform :logIssue, message
+    end
+    
+    def debug(message)
+      perform :logDebug, message
+    end
+    
+    def error(message)
+      perform :logError, message
+    end
+    
+    def message(message)
+      perform :logMessage, message
+    end
+    
+    def warning(message)
+      perform :logWarning, message
+    end
+  end
+end

data/lib/ui_automation/navigation_bar.rb

@@ -0,0 +1,17 @@
+module UIAutomation
+  # A RemoteProxy to UIANavigationBar objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIANavigationBarClassReference/
+  #
+  class NavigationBar < Element
+    ### @!group Elements
+
+    # The navigation bar's left button
+    has_element :leftButton
+    
+    # The navigation bar's right button
+    has_element :rightButton
+
+    ### @!endgroup    
+  end
+end

data/lib/ui_automation/picker.rb

@@ -0,0 +1,14 @@
+module UIAutomation
+  # A RemoteProxy to UIAPicker objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAPickerClassReference/
+  #
+  class Picker < Element
+    ### @!group Element Collections
+
+    # An array representing each wheel in the picker
+    has_element_array :wheels
+
+    ### @!endgroup
+  end
+end

data/lib/ui_automation/popover.rb

@@ -0,0 +1,23 @@
+module UIAutomation
+  # A RemoteProxy to UIAPopover objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAPopoverClassReference/
+  #
+  class Popover < Element
+    ### @!group Elements
+
+    # The action sheet contained by the popover
+    has_element :actionSheet, type: UIAutomation::ActionSheet
+    
+    # The navigation bar contained by the popover
+    has_element :navigationBar, type: UIAutomation::NavigationBar
+    
+    # The tab bar contained by the popover
+    has_element :tabBar, type: UIAutomation::TabBar
+    
+    # The toolbar contained by the popover
+    has_element :toolbar
+
+    ### @!endgroup
+  end
+end

data/lib/ui_automation/tab_bar.rb

@@ -0,0 +1,31 @@
+module UIAutomation
+  # A RemoteProxy to UIATabBar objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIATabBarClassReference/
+  #
+  class TabBar < Element
+    ### @!group Elements
+
+    # The currently selected tab
+    has_element :selectedButton
+
+    ### @!endgroup
+
+    def tabs
+      buttons
+    end
+    
+    alias_method :selected_tab, :selected_button
+
+    ### @!group Actions
+
+    # Selects the named tab
+    # @param [String] tab_name the tab's label
+    #
+    def tap_tab(tab_name)
+      tabs[tab_name].tap
+    end
+
+    ### @!endgroup
+  end
+end

data/lib/ui_automation/table_view.rb

@@ -0,0 +1,35 @@
+module UIAutomation
+  # A RemoteProxy to UIATableView objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIATableViewClassReference/
+  #
+  class TableView < Element
+    ### @!group Element Collections
+
+    # All of the cells in the table view
+    has_element_array :cells
+    
+    # ALl of the visible cells in the table view
+    has_element_array :visibleCells
+
+    ### @!endgroup
+    
+    ### @!group Actions
+
+    # Scrolls down to the named cell until it is visible on screen.
+    #
+    # @param [String] name the name of the cell to scroll to
+    def scroll_down_to_cell_named(name)
+      cells[name].until_element(:visible?) { scroll_down }
+    end
+    
+    # Scrolls up to the named cell until it is visible on screen.
+    #
+    # @param [String] name the name of the cell to scroll to
+    def scroll_up_to_cell_named(name)
+      cells[name].until_element(:visible?) { scroll_up }
+    end
+
+    ### @!endgroup
+  end
+end

data/lib/ui_automation/target.rb

@@ -0,0 +1,42 @@
+module UIAutomation
+  # A RemoteProxy to UIATarget objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIATargetClassReference/
+  #
+  class Target < RemoteProxy
+    # Returns an instance of UIAutomation::Target that represents the singleton local target (UIATarget.localTarget()).
+    # @return [UIAutomation::Target]
+    #
+    def self.local_target(executor)
+      from_javascript(executor, 'UIATarget.localTarget()')
+    end
+    
+    # Returns a proxy to the currently active app.
+    # @return [UIAutomation::Application]
+    #
+    def front_most_app
+      proxy_for(:frontMostApp, proxy_klass: UIAutomation::Application)
+    end
+    
+    # Sets the current location (iOS Simulator only).
+    # @param [Hash] coordinates A hash containing :lat and :lng keys.
+    #
+    def location=(coordinates)
+      set_location(coordinates)
+    end
+    
+    # Performs a tap on the element by tapping at the position
+    # of the element's rect.
+    #
+    # The preferred method of tapping an element is to just 
+    # call UIAutomation::Element#tap which calls the UIAElement tap() method
+    # directly on the element but this can sometimes fail on 
+    # certain elements - this method is provided as a fallback.
+    #
+    # @param [UIAutomation::Element] element The element to tap.
+    #
+    def tap_element(element)
+      perform(:tap, element.rect)
+    end
+  end
+end

data/lib/ui_automation/text_field.rb

@@ -0,0 +1,9 @@
+module UIAutomation
+  # A RemoteProxy to UIATextField objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIATextFieldClassReference/
+  #
+  class TextField < Element
+    include Traits::TextInput
+  end
+end

data/lib/ui_automation/text_view.rb

@@ -0,0 +1,9 @@
+module UIAutomation
+  # A RemoteProxy to UIATextView objects in the Javascript API.
+  #
+  # @see https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIATextViewClassReference/
+  #
+  class TextView < Element
+    include Traits::TextInput
+  end
+end

data/lib/ui_automation/traits/cancellable.rb

@@ -0,0 +1,12 @@
+module UIAutomation
+  module Traits
+    # Defines methods for elements that can be cancelled using a cancel button.
+    #
+    module Cancellable
+      # @return [UIAutomation::Element] The element's cancel button
+      def cancel_button
+        element_proxy_for(:cancelButton)
+      end
+    end
+  end
+end

data/lib/ui_automation/traits/text_input.rb

@@ -0,0 +1,58 @@
+module UIAutomation
+  module Traits
+    # Defines methods for elements that support text entry using the system keyboard.
+    #
+    module TextInput
+      ### @!group Actions    
+
+      # Sets the text of the text field directly, bypassing the keyboard.
+      #
+      # If the text field does not currently have keyboard focus, it will be tapped first.
+      #
+      # @param [String] value the text to use as the text field's new value
+      #
+      def text=(value)
+        with_keyboard_focus do
+          perform :setValue, value
+        end
+      end
+
+      # Begins typing in the text field using the on-screen keyboard
+      #
+      # If the text field has keyboard focus and the keyboard is visible, then the given 
+      # block will be called immediately.
+      #
+      # Otherwise, this method will tap the text field if necessary, wait until it reports that
+      # it has keyboard focus, wait for the keyboard to become visible if it isn't
+      # already and then call the block.
+      #
+      # As a convenience, a proxy to the keyboard is yielded to the block.
+      #
+      # This method does not dismiss the keyboard automatically.
+      #
+      # @example Simulate typing in a text field using the on-screen keyboard
+      #     text_field.begin_typing do |keyboard|
+      #       keyboard.type "some text"
+      #     end
+      #
+      # @yieldparam [UIAutomation::Keyboard] keyboard the keyboard proxy
+      #
+      def begin_typing(&block)
+        with_keyboard_focus do
+          application.keyboard.when_element(:visible?) do
+            yield application.keyboard if block_given?
+          end
+        end
+      end
+
+      ### @!endgroup
+
+      private
+
+      def with_keyboard_focus(&block)
+        tap unless has_keyboard_focus?
+        when_element(:has_keyboard_focus?, &block)
+      end
+    end
+  end
+end