calabash-cucumber 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f501008ee0e1a3152d8b681c2a6ccc5463a14057
-  data.tar.gz: 09c4bf7340eeb0f0b4ea96f1db3f477f829a68e0
+  metadata.gz: e84d4389afc2bd91cbdba73ecbee008b9e3bf89d
+  data.tar.gz: 221280823e7a79963e87dc3c429eab6480f1e2f6
 SHA512:
-  metadata.gz: 2bd0c0c774158fd2e8d3789b45a816ecf90b1073e17710c2f5869460fccc9ac8eb75e040c1d21ea84671cce24666467af8afc9e93c84f742a6e89f137ae7c6f0
-  data.tar.gz: 7b8e3efec441d1af9e46352c136b0ed95a7b875a29f04a1827ec6e62062a15e7d6ab08dac6709b0a930ca1f526236e5c0ec3098b793cfa927892bb3be8e7bd38
+  metadata.gz: 64384eb9d28415ac608f3e840159e8c051d6be5b11ece9e85b9a983aed8dfb5a9209d2ac7c2e873a6728cc882e74ca59a06b2da57ea921893af2fdb5e299dbff
+  data.tar.gz: cf001fb580c891bfbe8e6c1789ad9232d5e221b93e1d4caff370e9f25c7f849a4125d16e58f1e2829b4a332f50509d60b04bc588da042a5f0287e8c62fae567e

data/lib/calabash-cucumber/device.rb

@@ -7,10 +7,6 @@ module Calabash
     # Device encapsulates information about the device or simulator that the
     # app is running on.  It also includes the following information about the
     # app that is running on the current device.
-    #
-    # * The version of the embedded Calabash server.
-    # * Whether or not the app is an iPhone-only app that is being emulated on
-    #   an iPad.
     class Device
 
       include Calabash::Cucumber::Logging
@@ -68,24 +64,6 @@ module Calabash
       # @return [String] the version of the iOS that is running on this device
       attr_reader :ios_version
 
-      # The hardware architecture of this device.  Also known as the chip set.
-      #
-      # @example
-      #  # simulator
-      #  i386
-      #  x86_64
-      #
-      # @example
-      #  # examples from physical devices
-      #  armv6
-      #  armv7s
-      #  arm64
-      #
-      # @attribute [r] system
-      # @return [String] the hardware architecture of this device.
-      #  this device.
-      attr_reader :system
-
       # The version of the embedded Calabash server that is running in the
       # app under test on this device.
       #
@@ -117,7 +95,8 @@ module Calabash
       #   * iphone 3.5in
       #   * iphone 6
       #   * iphone 6+
-      #   * "" # if no information can be found.
+      #   * ipad pro
+      #   * unknown
       attr_reader :form_factor
 
       # For Calabash server version > 0.10.2 provides
@@ -136,16 +115,25 @@ module Calabash
       # @return [Hash] screen dimensions, scale and down/up sampling fraction.
       attr_reader :screen_dimensions
 
-      # @deprecated 0.13.1 no replacement
-      # Indicates whether or not this device has a 4in screen.
-      # @attribute [r] iphone_4in
-      # @return [Boolean] `true` if this device has a 4in screen.
-      attr_reader :iphone_4in
+      # Requires calabash server > 0.16.2
+      #
+      # * iPhone7,1
+      # * iPhone5,2
+      # * iPad6,1
+      # * iPad6,8
+      #
+      # @attribute [r] model_identifier
+      # @return [String] The low-level model identifier.
+      attr_reader :model_identifier
 
-      # @deprecated 0.10.0 no replacement
-      # @!attribute [rw] udid
-      # @return [String] The udid of this device.
-      attr_accessor :udid
+      # Requires calabash server > 0.16.2
+      #
+      # For simulators, this is known to return '< form factor > Simulator'
+      #
+      # For devices, this will return the name of the device as seen in Xcode.
+      #
+      # @attribute [r] device_name
+      attr_reader :device_name
 
       # Creates a new instance of Device.
       #
@@ -155,14 +143,21 @@ module Calabash
       # @param [Hash] version_data the output of the `server_version` function
       # @return [Device] a new Device instance
       def initialize (endpoint, version_data)
-        simulator_device = version_data['simulator_device']
         @endpoint = endpoint
-        @system = version_data['system']
-        @device_family = @system.eql?(GESTALT_SIM_SYS) ? simulator_device : @system.split(/[\d,.]/).first
+        @model_identifier = version_data['model_identifier']
         @simulator_details = version_data['simulator']
-        @ios_version = version_data['iOS_version']
+        @ios_version = version_data['ios_version']
         @server_version = version_data['version']
         @iphone_app_emulated_on_ipad = version_data['iphone_app_emulated_on_ipad']
+        @form_factor = version_data['form_factor']
+        @device_name = version_data['device_name']
+
+        family = version_data['device_family']
+        if family
+          @device_family = family.split(' ').first
+        end
+
+        # Available 0.10.2
         screen_dimensions = version_data['screen_dimensions']
         if screen_dimensions
           @screen_dimensions = {}
@@ -170,7 +165,25 @@ module Calabash
             @screen_dimensions[key.to_sym] = val
           end
         end
-        @form_factor = version_data['form_factor']
+
+        # Deprecated 0.16.2 server
+        @system = version_data['system']
+
+        # 0.16.2 server adds 'device_family' key.
+        unless @device_family
+          # Deprecated 0.16.2 server
+          simulator_device = version_data['simulator_device']
+          if @system == GESTALT_SIM_SYS
+            @device_family = simulator_device
+          else
+            @device_family = @system.split(/[\d,.]/).first
+          end
+        end
+
+        # 0.16.2 server adds 'ios_version' key
+        unless @ios_version
+          @ios_version = version_data['iOS_version']
+        end
 
         # Deprecated 0.13.0
         @iphone_4in = version_data['4inch']
@@ -179,7 +192,12 @@ module Calabash
       # Is this device a simulator or physical device?
       # @return [Boolean] true if this device is a simulator
       def simulator?
-        system.eql?(GESTALT_SIM_SYS)
+        # Post 0.16.2 server
+        if simulator_details
+          true
+        else
+          system == GESTALT_SIM_SYS
+        end
       end
 
       # Is this device a device or simulator?
@@ -230,48 +248,46 @@ module Calabash
         form_factor == 'iphone 3.5in'
       end
 
-      # @!visibility private
-      def version_hash (version_str)
-        tokens = version_str.split(/[,.]/)
-        {:major_version => tokens[0],
-         :minor_version => tokens[1],
-         :bug_version => tokens[2]}
+      # Is this device an iPad Pro?
+      # @return [Boolean] true if this device is an iPad Pro
+      def ipad_pro?
+        form_factor == 'ipad pro'
       end
 
       # The major iOS version of this device.
       # @return [String] the major version of the OS
       def ios_major_version
-        version_hash(ios_version)[:major_version]
+        ios_version_object.major.to_s
       end
 
       # Is this device running iOS 9?
       # @return [Boolean] true if the major version of the OS is 9
       def ios9?
-        ios_major_version == '9'
+        ios_version_object.major == 9
       end
 
       # Is this device running iOS 8?
       # @return [Boolean] true if the major version of the OS is 8
       def ios8?
-        ios_major_version.eql?('8')
+        ios_version_object.major == 8
       end
 
       # Is this device running iOS 7?
       # @return [Boolean] true if the major version of the OS is 7
       def ios7?
-        ios_major_version.eql?('7')
+        ios_version_object.major == 7
       end
 
       # Is this device running iOS 6?
       # @return [Boolean] true if the major version of the OS is 6
       def ios6?
-        ios_major_version.eql?('6')
+        ios_version_object.major == 6
       end
 
       # Is this device running iOS 5?
       # @return [Boolean] true if the major version of the OS is 5
       def ios5?
-        ios_major_version.eql?('5')
+        ios_version_object.major == 5
       end
 
       # @deprecated 0.11.2 Replaced with screen_dimensions.
@@ -298,9 +314,12 @@ module Calabash
         iphone_app_emulated_on_ipad
       end
 
+      # @deprecated 0.9.169 replaced with `server_version`
+      #
+      # @see #server_version
+      #
       # The version of the embedded Calabash server running in the app under
       # test on this device.
-      # @deprecated 0.9.169 replaced with `server_version`
       # @see #server_version
       # @return [String] the version of the embedded Calabash server
       def framework_version
@@ -321,7 +340,9 @@ module Calabash
       end
 
       # @deprecated 0.9.168 replaced with iphone_4in?
+      #
       # @see #iphone_4in?
+      #
       # Is this device an iPhone 5?
       # @note Deprecated because the iPhone 5S reports as an iPhone6,*.
       # @return [Boolean] true if this device is an iPhone 5
@@ -331,13 +352,52 @@ module Calabash
       end
 
       # @deprecated 0.13.1 - Call `iphone_4in?` instead.
+      #
       # @see #iphone_4in?
+      #
       # @note Deprecated after introducing new `form_factor` behavior.
       # @return [Boolean] true if this device is an iPhone 5 or 5s
       def iphone_4in
         _deprecated('0.13.1', "use 'iphone_4in?' instead", :warn)
         @iphone_4in
       end
+
+      # @deprecated 0.16.2 No replacement.
+      #
+      # @example
+      #  # simulator
+      #  i386
+      #  x86_64
+      #
+      # @example
+      #  # examples from physical devices
+      #  iPhone7,1
+      #  iPhone5,2
+      #
+      # @attribute [r] system
+      # @return [String] The model of this device.
+      #  this device.
+      attr_reader :system
+
+      # @deprecated 0.13.1 no replacement
+      #
+      # Indicates whether or not this device has a 4in screen.
+      # @attribute [r] iphone_4in
+      # @return [Boolean] `true` if this device has a 4in screen.
+      attr_reader :iphone_4in
+
+      # @deprecated 0.10.0 no replacement
+      #
+      # @!attribute [rw] udid
+      # @return [String] The udid of this device.
+      attr_accessor :udid
+
+      private
+
+      # @!visibility private
+      def ios_version_object
+        @ios_version_object ||= RunLoop::Version.new(ios_version)
+      end
     end
   end
 end

data/lib/calabash-cucumber/environment_helpers.rb

@@ -78,6 +78,14 @@ module Calabash
         _default_device_or_create.ipod?
       end
 
+      # Is the device under test an iPad Pro
+      #
+      # @raise [RuntimeError] If the server cannot be reached.
+      # @return [Boolean] true if device under test is an iPod.
+      def ipad_pro?
+        _default_device_or_create.ipad_pro?
+      end
+
       # Is the device under test an iPhone or iPod?
       #
       # @raise [RuntimeError] If the server cannot be reached.

data/lib/calabash-cucumber/rotation_helpers.rb

@@ -10,6 +10,7 @@ module Calabash
       include Calabash::Cucumber::Logging
 
       # @!visibility private
+      # @deprecated 0.16.1
       def rotation_candidates
         %w(rotate_left_home_down rotate_left_home_left rotate_left_home_right rotate_left_home_up
            rotate_right_home_down rotate_right_home_left rotate_right_home_right rotate_right_home_up)
@@ -44,7 +45,7 @@ module Calabash
       # @note This method generates verbose messages when full console logging
       #  is enabled.  See {Calabash::Cucumber::Logging#full_console_logging?}.
       #
-      # @param [Symbol] dir The position of the home button after the rotation.
+      # @param [Symbol] direction The position of the home button after the rotation.
       #  Can be one of `{:down | :left | :right | :up }`.
       #
       # @note A rotation will only occur if your view controller and application
@@ -52,117 +53,215 @@ module Calabash
       #
       # @return [Symbol] The position of the home button relative to the status
       #  bar when all rotations have been completed.
-      def rotate_home_button_to(dir)
-        dir_sym = dir.to_sym
-        if dir_sym.eql?(:top)
-          if full_console_logging?
-            calabash_warn "converting '#{dir}' to ':up' - please adjust your code"
-          end
-          dir_sym = :up
+      def rotate_home_button_to(direction)
+
+        begin
+          as_symbol = ensure_valid_rotate_home_to_arg(direction)
+        rescue ArgumentError => e
+          raise ArgumentError, e.message
         end
 
-        if dir_sym.eql?(:bottom)
-          if full_console_logging?
-            calabash_warn "converting '#{dir}' to ':down' - please adjust your code"
-          end
-          dir_sym = :down
+        current_orientation = status_bar_orientation.to_sym
+
+        return current_orientation if current_orientation == as_symbol
+
+        rotate_to_uia_orientation(as_symbol)
+        recalibrate_after_rotation
+        status_bar_orientation.to_sym
+      end
+
+      # Rotates the device in the direction indicated by `direction`.
+      #
+      # @example rotate left
+      #  rotate :left
+      #
+      # @example rotate right
+      #  rotate :right
+      #
+      # @param [Symbol] direction The direction to rotate. Can be :left or :right.
+      #
+      # @return [Symbol] The position of the home button relative to the status
+      #   bar after the rotation.  Will be one of `{:down | :left | :right | :up }`.
+      # @raise [ArgumentError] If direction is not :left or :right.
+      def rotate(direction)
+
+        as_symbol = direction.to_sym
+
+        if as_symbol != :left && as_symbol != :right
+          raise ArgumentError,
+                "Expected '#{direction}' to be :left or :right"
         end
 
-        directions = [:down, :up, :left, :right]
-        unless directions.include?(dir_sym)
-          screenshot_and_raise "expected one of '#{directions}' as an arg to 'rotate_home_button_to but found '#{dir}'"
+        current_orientation = status_bar_orientation.to_sym
+
+        result = rotate_with_uia(as_symbol, current_orientation)
+
+        recalibrate_after_rotation
+
+        ap result if debug_logging?
+
+        status_bar_orientation
+      end
+
+      private
+
+      # @! visibility private
+      def recalibrate_after_rotation
+        uia_query :window
+      end
+
+      # @! visibility private
+      def ensure_valid_rotate_home_to_arg(arg)
+        coerced = arg.to_sym
+
+        if coerced == :top
+          coerced = :up
+        elsif coerced == :bottom
+          coerced = :down
         end
 
-        res = status_bar_orientation()
-        if res.nil?
-          screenshot_and_raise "expected 'status_bar_orientation' to return a non-nil value"
-        else
-          res = res.to_sym
+        allowed = [:down, :up, :left, :right]
+        unless allowed.include?(coerced)
+          raise ArgumentError,
+                "Expected '#{arg}' to be :down, :up, :left, or :right"
         end
+        coerced
+      end
+
+      # @! visibility private
+      UIA_DEVICE_ORIENTATION = {
+            :portrait => 1,
+            :upside_down => 2,
+            :landscape_left => 3,
+            :landscape_right => 4
+      }.freeze
 
-        return res if res.eql? dir_sym
+      # @! visibility private
+      # @deprecated 0.16.1
+      def rotate_home_button_to_position_with_playback(home_button_position)
 
-        rotation_candidates.each { |candidate|
-          if full_console_logging?
-            puts "try to rotate to '#{dir_sym}' using '#{candidate}'"
+        rotation_candidates.each do |candidate|
+          if debug_logging?
+            calabash_info "Trying to rotate Home Button to '#{home_button_position}' using '#{candidate}'"
           end
+
           playback(candidate)
           sleep(0.4)
-          recalibrate_after_rotation()
+          recalibrate_after_rotation
 
-          res = status_bar_orientation
-          if res.nil?
-            screenshot_and_raise "expected 'status_bar_orientation' to return a non-nil value"
-          else
-            res = res.to_sym
+          current_orientation = status_bar_orientation.to_sym
+          if current_orientation == home_button_position
+            return current_orientation
           end
+        end
 
-          return if res.eql? dir_sym
-        }
-
-        if full_console_logging?
-          calabash_warn "Could not rotate home button to '#{dir}'."
-          calabash_warn 'Is rotation enabled for this controller?'
-          calabash_warn "Will return 'down'"
+        if debug_logging?
+          calabash_warn %Q{
+Could not rotate Home Button to '#{home_button_position}'."
+Is rotation enabled for this controller?}
         end
         :down
       end
 
-      # Rotates the device in the direction indicated by `dir`.
-      #
-      # @example rotate left
-      #  rotate :left
-      #
-      # @example rotate right
-      #  rotate :right
-      #
-      # @param [Symbol] dir The direction to rotate.  Can be :left or :right.
-      #
-      # @return [Symbol] The position of the home button relative to the status
-      #   bar after the rotation.  Can be one of `{:down | :left | :right | :up }`.
-      def rotate(dir)
-        dir = dir.to_sym
-        current_orientation = status_bar_orientation().to_sym
-        rotate_cmd = nil
-        case dir
+      # @! visibility private
+      def rotate_to_uia_orientation(orientation)
+        case orientation
+          when :down then key = :portrait
+          when :up then key = :upside_down
+          when :left then key = :landscape_right
+          when :right then key = :landscape_left
+          else
+            raise ArgumentError,
+                  "Expected '#{orientation}' to be :left, :right, :up, or :down"
+        end
+        value = UIA_DEVICE_ORIENTATION[key]
+        cmd = "UIATarget.localTarget().setDeviceOrientation(#{value})"
+        uia(cmd)
+      end
+
+      # @! visibility private
+      def rotate_with_uia(direction, current_orientation)
+        key = uia_orientation_key(direction, current_orientation)
+        value = UIA_DEVICE_ORIENTATION[key]
+        cmd = "UIATarget.localTarget().setDeviceOrientation(#{value})"
+        uia(cmd)
+      end
+
+      # @! visibility private
+      def uia_orientation_key(direction, current_orientation)
+
+        key = nil
+        case direction
           when :left then
             if current_orientation == :down
-              rotate_cmd = 'left_home_down'
+              key = :landscape_right
             elsif current_orientation == :right
-              rotate_cmd = 'left_home_right'
+              key = :portrait
             elsif current_orientation == :left
-              rotate_cmd = 'left_home_left'
+              key = :upside_down
             elsif current_orientation == :up
-              rotate_cmd = 'left_home_up'
+              key = :landscape_left
             end
           when :right then
             if current_orientation == :down
-              rotate_cmd = 'right_home_down'
-            elsif current_orientation == :left
-              rotate_cmd = 'right_home_left'
+              key = :landscape_left
             elsif current_orientation == :right
-              rotate_cmd = 'right_home_right'
+              key = :upside_down
+            elsif current_orientation == :left
+              key = :portrait
             elsif current_orientation == :up
-              rotate_cmd = 'right_home_up'
+              key = :landscape_right
             end
+          else
+            raise ArgumentError,
+                  "Expected '#{direction}' to be :left or :right"
         end
+        key
+      end
 
-        if rotate_cmd.nil?
-          if full_console_logging?
-            puts "Could not rotate device in direction '#{dir}' with orientation '#{current_orientation} - will do nothing"
-          end
-        else
-          result = playback("rotate_#{rotate_cmd}")
-          recalibrate_after_rotation
-          result
+      # @! visibility private
+      # @deprecated 0.16.1
+      def recording_name(direction, current_orientation)
+        recording_name = nil
+        case direction
+          when :left then
+            if current_orientation == :down
+              recording_name = 'left_home_down'
+            elsif current_orientation == :right
+              recording_name = 'left_home_right'
+            elsif current_orientation == :left
+              recording_name = 'left_home_left'
+            elsif current_orientation == :up
+              recording_name = 'left_home_up'
+            end
+          when :right then
+            if current_orientation == :down
+              recording_name = 'right_home_down'
+            elsif current_orientation == :left
+              recording_name = 'right_home_left'
+            elsif current_orientation == :right
+              recording_name = 'right_home_right'
+            elsif current_orientation == :up
+              recording_name = 'right_home_up'
+            end
+          else
+            raise ArgumentError,
+                  "Expected '#{direction}' to be 'left' or 'right'"
         end
+        "rotate_#{recording_name}"
       end
 
-      def recalibrate_after_rotation
-        uia_query :window
-      end
+      # @! visibility private
+      # @deprecated 0.16.1
+      def rotate_with_playback(direction, current_orientation)
+        name = recording_name(direction, current_orientation)
 
+        if debug_logging?
+          puts "Could not rotate device '#{direction}' given '#{current_orientation}'; nothing to do."
+        end
 
+        playback(name)
+      end
     end
   end
 end

data/lib/calabash-cucumber/version.rb

@@ -3,10 +3,10 @@ module Calabash
 
     # @!visibility public
     # The Calabash iOS gem version.
-    VERSION = '0.16.1'
+    VERSION = '0.16.2'
 
     # @!visibility public
     # The minimum required version of the Calabash embedded server.
-    MIN_SERVER_VERSION = '0.16.1'
+    MIN_SERVER_VERSION = '0.16.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calabash-cucumber
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.16.2
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.5.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -156,7 +156,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.5.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'