calabash 2.0.0.pre10 → 2.0.0.pre11

data/lib/calabash/interactions.rb

@@ -62,7 +62,7 @@ module Calabash
     #
     # @return [Calabash::QueryResult] A result of the query
     def query(query, *args)
-      Calabash::Device.default.map_route(Query.new(query), :query, *args)
+      Calabash::Internal.with_default_device {|device| device.map_route(Query.new(query), :query, *args)}
     end
 
     # Flashes any views matching `query`. Only one view is flashed at a time,
@@ -71,39 +71,7 @@ module Calabash
     # @param [String, Hash, Calabash::Query] query The query to match the
     #  view(s)
     def flash(query)
-      Calabash::Device.default.map_route(Query.new(query), :flash)
-    end
-
-    # Evaluate javascript in a Web View. On iOS, an implicit return is
-    # inserted, on Android an explicit return is needed.
-    #
-    # @example
-    #  # iOS
-    #  evaluate_javascript_in("UIWebView", "2+2")
-    #  # Android
-    #  evaluate_javascript_in("WebView", "return 2+2")
-    #
-    # @example
-    #  # iOS
-    #  evaluate_javascript_in("WKWebView",
-    #         "document.body.style.backgroundColor = 'red';")
-    #
-    #  # Android
-    #  evaluate_javascript_in("XWalkContent",
-    #         "document.body.style.backgroundColor = 'red';")
-    #
-    # @note No error will be raised if the javascript given is invalid, or
-    #  throws an exception.
-    #
-    # @param [String, Hash, Calabash::Query] query Query that matches the view
-    # @param [String] javascript The javascript to evaluate
-    #
-    # @raise ViewNotFoundError If no views are found matching `query`
-    def evaluate_javascript_in(query, javascript)
-      wait_for_view(query,
-                    timeout: Calabash::Gestures::DEFAULT_GESTURE_WAIT_TIMEOUT)
-
-      _evaluate_javascript_in(query, javascript)
+      Calabash::Internal.with_default_device {|device| device.map_route(Query.new(query), :flash)}
     end
 
     # Invoke a method in your application.
@@ -158,12 +126,7 @@ module Calabash
     # @return [Object] the result of performing the selector/method with the
     #  arguments (serialized)
     def backdoor(name, *arguments)
-      Device.default.backdoor(name, *arguments)
-    end
-
-    # @!visibility private
-    def _evaluate_javascript_in(query, javascript)
-      abstract_method!
+      Calabash::Internal.with_default_device {|device| device.backdoor(name, *arguments)}
     end
   end
 end

data/lib/calabash/internal.rb

@@ -0,0 +1,48 @@
+module Calabash
+  # @!visibility private
+  # Internal usage, NOT a public API
+  module Internal
+    def self.with_default_device(required_os: nil, &block)
+      unless block
+        raise ArgumentError, "No block given"
+      end
+
+      device = Calabash.default_device
+
+      if device.nil?
+        raise "The default device is not set. Set it using Calabash.default_device = ..."
+      end
+
+      if required_os
+        required_class = nil
+        required_type = nil
+        current_type = nil
+
+        case required_os
+          when :ios
+            required_class = Calabash::IOS::Device
+            required_type = 'iOS'
+          when :android
+            required_class = Calabash::Android::Device
+            required_type = 'Android'
+          else
+            raise ArgumentError, "Unknown OS '#{required_os}'"
+        end
+
+        if Calabash::Android.const_defined?(:Device, false) && device.is_a?(Calabash::Android::Device)
+            current_type = 'Android'
+        elsif Calabash::IOS.const_defined?(:Device, false) && device.is_a?(Calabash::IOS::Device)
+            current_type = 'iOS'
+        else
+            current_type = 'unknown'
+        end
+
+        unless device.is_a?(required_class)
+          raise "The default device is not set to an #{required_type} device, it is an #{current_type} device."
+        end
+      end
+
+      block.call(device)
+    end
+  end
+end

data/lib/calabash/ios.rb

@@ -1,21 +1,7 @@
 module Calabash
-  # Contains the iOS implementations of the Calabash APIs.
-  module IOS
+  # @!visibility private
+  module IOSInternal
     require 'calabash'
-    include Calabash
-
-    # @!visibility private
-    def self.extended(base)
-      Calabash.send(:extended, base)
-    end
-
-    # @!visibility private
-    def self.included(base)
-      Calabash.send(:included, base)
-    end
-
-    require 'calabash/ios/defaults'
-    extend Calabash::IOS::Defaults
 
     require 'calabash/ios/environment'
     require 'calabash/ios/application'
@@ -32,6 +18,8 @@ module Calabash
     require 'calabash/ios/gestures'
     require 'calabash/ios/slider'
     require 'calabash/ios/date_picker'
+    require 'calabash/ios/automator'
+    require 'calabash/ios/web'
 
     include Calabash::IOS::Conditions
     include Calabash::IOS::Orientation
@@ -43,7 +31,79 @@ module Calabash
     include Calabash::IOS::Gestures
     include Calabash::IOS::Slider
     include Calabash::IOS::DatePicker
+    include Calabash::IOS::Web
+  end
+
+  # Contains the iOS implementations of the Calabash APIs.
+  module IOS
+    require 'calabash'
+    # Hide from documentation
+    send(:include, Calabash)
+
+    # @!visibility private
+    def self.extended(base)
+      Calabash.send(:extended, base)
+    end
+
+    # @!visibility private
+    def self.included(base)
+      Calabash.send(:included, base)
+    end
+
+    include ::Calabash::IOSInternal
+
+    require 'calabash/ios/defaults'
+    extend Calabash::IOS::Defaults
 
     require 'calabash/ios/legacy'
   end
 end
+
+# @!visibility private
+class CalabashIOSMethodsInternal
+  include ::Calabash::IOS
+end
+
+# @!visibility private
+class CalabashIOSMethods < BasicObject
+  include ::Calabash::IOSInternal
+
+  instance_methods.each do |method_name|
+    define_method(method_name) do |*args, &block|
+      ::CalabashIOSMethodsInternal.new.send(method_name, *args, &block)
+    end
+  end
+end
+
+# Returns a object that exposes all of the public Calabash iOS API.
+# This method should *always* be used to access the Calabash API. By default,
+# all methods are executed using the default device and the default
+# application.
+#
+# For iOS specific methods use {cal_android}. For cross-platform methods use
+# {cal}.
+#
+# All iOS API methods are available with documentation in {Calabash::IOS}
+#
+# @see Calabash::IOS
+#
+# @return [Object] Instance responding to all Calabash iOS methods
+#  in the API.
+def cal_ios
+  CalabashIOSMethods.new
+end
+
+# We also want to patch `cal` to invoke the iOS implementations
+class CalabashMethodsInternal
+  include ::Calabash::IOS
+
+  instance_methods.each do |method_name|
+    define_method(method_name) do |*args, &block|
+      ::CalabashIOSMethodsInternal.new.send(method_name, *args, &block)
+    end
+  end
+end
+
+if defined?(::Calabash::AndroidInternal)
+  raise Calabash::RequiredBothPlatformsError, "Cannot require both calabash/android and calabash/ios"
+end

data/lib/calabash/ios/automator.rb

@@ -0,0 +1,9 @@
+module Calabash
+  module IOS
+    module Automator
+      require 'calabash/ios/automator/automator'
+      require 'calabash/ios/automator/coordinates'
+      require 'calabash/ios/automator/device_agent'
+    end
+  end
+end

data/lib/calabash/ios/automator/automator.rb

@@ -0,0 +1,217 @@
+module Calabash
+  module IOS
+    # @!visibility private
+    module Automator
+      # @!visibility private
+      class Automator
+        include Utility
+
+        # @!visibility private
+        def initialize(*args)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def name
+          abstract_method!
+        end
+
+        # @!visibility private
+        def stop
+          abstract_method!
+        end
+
+        # @!visibility private
+        def running?
+          abstract_method!
+        end
+
+        # @!visibility private
+        def client
+          abstract_method!
+        end
+
+        # @!visibility private
+        def touch(options)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def double_tap(options)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def two_finger_tap(options)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def touch_hold(options)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def flick(options)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def pan(options={})
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Callers must validate the options.
+        def pan_coordinates(from_point, to_point, options={})
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Callers must validate the options.
+        def pinch(in_or_out, options)
+          abstract_method!
+        end
+
+        # @!visibility private
+        def send_app_to_background(seconds)
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # It is the caller's responsibility to:
+        # 1. expect the keyboard is visible
+        # 2. escape the existing text
+        def enter_text_with_keyboard(string, options={})
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Respond to keys like 'Delete' or 'Return'.
+        def char_for_keyboard_action(action_key)
+          abstract_method!
+        end
+
+        # @!visibility private
+        # It is the caller's responsibility to ensure the keyboard is visible.
+        def enter_char_with_keyboard(char)
+          abstract_method!
+        end
+
+        # @!visibility private
+        # It is the caller's responsibility to ensure the keyboard is visible.
+        def tap_keyboard_action_key(return_key_type_of_first_responder)
+          abstract_method!
+        end
+
+        # @!visibility private
+        # It is the caller's responsibility to ensure the keyboard is visible.
+        def tap_keyboard_delete_key
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Legacy API - can we remove this method?
+        #
+        # It is the caller's responsibility to ensure the keyboard is visible.
+        def fast_enter_text(text)
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Caller is responsible for limiting calls to iPads and waiting for the
+        # keyboard to disappear.
+        def dismiss_ipad_keyboard
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Caller is responsible for providing a valid direction.
+        def rotate(direction, status_bar_orientation)
+          abstract_method!
+        end
+
+        # @!visibility private
+        #
+        # Caller is responsible for normalizing and validating the position.
+        def rotate_home_button_to(position, status_bar_orientation)
+          abstract_method!
+        end
+
+        # @! visibility private
+        #
+        # It is important to remember that the current orientation is the
+        # position of the home button:
+        #
+        # :up => home button on the top => upside_down
+        # :bottom => home button on the bottom => portrait
+        # :left => home button on the left => landscape_right
+        # :right => home button on the right => landscape_left
+        #
+        # Notice how :left and :right are mapped.
+        def self.orientation_key(direction, current_orientation)
+          key = nil
+          case direction
+            when :left then
+              if current_orientation == :down
+                key = :landscape_left
+              elsif current_orientation == :right
+                key = :upside_down
+              elsif current_orientation == :left
+                key = :portrait
+              elsif current_orientation == :up
+                key = :landscape_right
+              end
+            when :right then
+              if current_orientation == :down
+                key = :landscape_right
+              elsif current_orientation == :right
+                key = :portrait
+              elsif current_orientation == :left
+                key = :upside_down
+              elsif current_orientation == :up
+                key = :landscape_left
+              end
+            else
+              raise ArgumentError,
+                    "Expected '#{direction}' to be :left or :right"
+          end
+
+          key
+        end
+
+        # @!visibility private
+        def self.orientation_for_key(key)
+          DEVICE_ORIENTATION[key]
+        end
+
+        # @! visibility private
+        #
+        # It is important to remember that the current orientation is the
+        # position of the home button:
+        #
+        # :up => home button on the top => upside_down
+        # :bottom => home button on the bottom => portrait
+        # :left => home button on the left => landscape_right
+        # :right => home button on the right => landscape_left
+        #
+        # Notice how :left and :right are mapped to their logical opposite.
+        # @!visibility private
+        # @! visibility private
+        DEVICE_ORIENTATION = {
+            :portrait => 1,
+            :upside_down => 2,
+            :landscape_left => 3, # Home button on the right
+            :landscape_right => 4 # Home button on the left
+        }.freeze
+      end
+    end
+  end
+end