calabash 1.2.1 → 1.9.9.pre1

data/lib/calabash/life_cycle.rb

@@ -0,0 +1,111 @@
+module Calabash
+  module LifeCycle
+    def start_app(path_or_application = nil, **opt)
+      path_or_application ||= Application.default
+
+      unless path_or_application
+        raise 'No application given, and Application.default is not set'
+      end
+
+      Device.default.start_app(path_or_application, opt.dup)
+    end
+
+    def stop_app
+      Device.default.stop_app
+    end
+
+    # Installs the given application. If the application is already installed,
+    # the application will be uninstalled, and installed afterwards. If no
+    # application is given, it will install `Application.default`.
+    #
+    # If the given application is an instance of
+    # `Calabash::Android::Application`, the same procedure is executed for the
+    # test-server of the application, if it is set.
+    #
+    # @param [String, Calabash::Application] path_or_application A path to the
+    #  application, or an instance of `Calabash::Application`. Defaults to
+    #  `Application.default`
+    def install_app(path_or_application = nil)
+      path_or_application ||= Application.default
+
+      unless path_or_application
+        raise 'No application given, and Application.default is not set'
+      end
+
+      Device.default.install_app(path_or_application)
+    end
+
+    # Installs the given application *if it is not already installed*. If no
+    # application is given, it will ensure `Application.default` is installed.
+    # If the application has changed, it will be installed using the same
+    # approach as #{Calabash::LifeCycle#install_app}.
+    #
+    # If the given application is an instance of
+    # `Calabash::Android::Application`, the same procedure is executed for the
+    # test-server of the application, if it is set.
+    #
+    # @param [String, Calabash::Application] path_or_application A path to the
+    #  application, or an instance of `Calabash::Application`. Defaults to
+    #  `Application.default`
+    def ensure_app_installed(path_or_application = nil)
+      path_or_application ||= Application.default
+
+      unless path_or_application
+        raise 'No application given, and Application.default is not set'
+      end
+
+      Device.default.ensure_app_installed(path_or_application)
+    end
+
+    # Uninstalls the given application. Does nothing if the application is
+    # already uninstalled. If no application is given, it will uninstall
+    # `Application.default`.
+    #
+    # @param [String, Calabash::Application] path_or_application A path to the
+    #  application, or an instance of `Calabash::Application`. Defaults to
+    #  `Application.default`
+    def uninstall_app(path_or_application = nil)
+      path_or_application ||= Application.default
+
+      unless path_or_application
+        raise 'No application given, and Application.default is not set'
+      end
+
+      Device.default.uninstall_app(path_or_application)
+    end
+
+    # Clears the contents of the given application. This is roughly equivalent to
+    # reinstalling the application. If no  application is given, it will clear
+    # `Application.default`.
+    #
+    # @param [String, Calabash::Application] path_or_application A path to the
+    #  application, or an instance of `Calabash::Application`. Defaults to
+    #  `Application.default`
+    def clear_app_data(path_or_application = nil)
+      path_or_application ||= Application.default
+
+      unless path_or_application
+        raise 'No application given, and Application.default is not set'
+      end
+
+      Device.default.clear_app_data(path_or_application)
+    end
+
+    # Sends the current app to the background and resumes it after
+    # `for_seconds`. This should not exceed 60 seconds for iOS.
+    #
+    # On Android you can control the app lifecycle more granularly using
+    # #{Calabash::Android::Interactions#go_home} and
+    # #{Calabash::Android::LifeCycle#resume_app}.
+    def send_current_app_to_background(for_seconds = 10)
+      _send_current_app_to_background(for_seconds)
+
+      true
+    end
+
+    # !@visibility private
+    def _send_current_app_to_background(for_seconds)
+      abstract_method!
+    end
+  end
+end

data/lib/calabash/location.rb

@@ -0,0 +1,51 @@
+require 'geocoder'
+
+module Calabash
+  module Location
+    # Simulates gps location of the device/simulator.
+    # @note Seems UIAutomation is broken here on physical devices on iOS 7.1
+    #
+    # @example
+    #  set_location({latitude: 48.8567, longitude: 2.3508})
+    #
+    # @example
+    #  set_location(coordinates_for_place('The little mermaid, Copenhagen'))
+    #
+    # @param {Hash} options specifies which location to simulate
+    # @option options {Numeric} :latitude latitude of a gps coordinate (same
+    #  coordinate system as Google maps)
+    # @option options {Numeric} :longitude longitude of a gps coordinate (same
+    #  coordinate system as Google maps)
+    def set_location(location)
+      unless location.is_a?(Hash)
+        raise ArgumentError, "Expected location to be a Hash, not '#{location.class}'"
+      end
+
+      unless location[:latitude] || location[:longitude]
+        raise ArgumentError, "You must supply :latitude and :longitude"
+      end
+
+      Device.default.set_location(location)
+    end
+
+    # Get the latitude and longitude for a certain place, resolved via Google
+    # maps api. This hash can be used in `set_location`.
+    #
+    # @example
+    #  coordinates_for_place('The little mermaid, Copenhagen')
+    #  # => {:latitude => 55.6760968, :longitude => 12.5683371}
+    #
+    # @return [Hash] Latitude and longitude for the given place
+    # @raise [RuntimeError] If the place cannot be found
+    def coordinates_for_place(place)
+      result = Geocoder.search(place)
+
+      if result.empty?
+        raise "No result found for '#{place}'"
+      end
+
+      {latitude: result.first.latitude,
+       longitude: result.first.longitude}
+    end
+  end
+end

data/lib/calabash/logger.rb

@@ -0,0 +1,87 @@
+module Calabash
+
+  # A logger for Calabash.
+  class Logger
+    attr_accessor :default_log_level
+
+    def initialize(output=nil)
+      @output = output || STDOUT.dup
+      @default_log_level = :debug
+    end
+
+    # Log a message
+    #
+    # @param [String] message to log
+    # @param [Symbol] log_level
+    #  Can be one of `{:info | :debug | :warn | :error }`
+    def log(message, log_level = default_log_level)
+      @output.write("#{message}\n") if should_log?(log_level)
+    end
+
+    private
+
+    # @!visibility private
+    def should_log?(log_level)
+      Logger.log_levels.include?(log_level)
+    end
+
+    public
+
+    if Environment::DEBUG
+      @@log_levels = [:info, :warn, :error, :debug]
+    else
+      @@log_levels = [:info, :warn, :error]
+    end
+
+    # Log a message to the default output
+    #
+    # @param [String] message to log
+    # @param [Symbol] log_level (:debug, :info, :warning, :error)
+    #  Can be one of `{:info | :debug | :warn | :error }`
+    def self.log(message, log_level = :info)
+      Logger.new.log(message, log_level)
+    end
+
+    # Log a message to the default output with log level :info
+    #
+    # @param [String] message to log
+    def self.info(message)
+      log(message, :info)
+    end
+
+    # Log a message to the default output with log level :debug
+    #
+    # @param [String] message to log
+    def self.debug(message)
+      log(message, :debug)
+    end
+
+    # Log a message to the default output with log level :warn
+    #
+    # @param [String] message to log
+    def self.warn(message)
+      log(message, :warn)
+    end
+
+    # Log a message to the default output with log level :error
+    #
+    # @param [String] message to log
+    def self.error(message)
+      log(message, :error)
+    end
+
+    # The log levels of the logger
+    #
+    # @return [Array] log levels
+    def self.log_levels
+      @@log_levels
+    end
+
+    # Set the log levels of the logger
+    #
+    # @param [Array] log_levels
+    def self.log_levels=(log_levels)
+      @@log_levels = log_levels
+    end
+  end
+end

data/lib/calabash/orientation.rb

@@ -0,0 +1,84 @@
+module Calabash
+
+  # Methods for querying an app's orientation and for rotating the app into
+  # different orientations.
+  module Orientation
+    # Is the device in the portrait orientation?
+    #
+    # @return [Boolean] Returns true if the device is in the 'up' or 'down'
+    #  orientation.
+    def portrait?
+      _portrait?
+    end
+
+    # Is the device in the landscape orientation?
+    #
+    # @return [Boolean] Returns true if the device is in the 'left' or 'right'
+    #  orientation.
+    def landscape?
+      _landscape?
+    end
+
+    # Set the device orientation to portrait.
+    #
+    # In portrait orientation, the display of the device has a bigger width
+    # than height.
+    #
+    # On iOS, the presenting view controller must respond to rotation events.
+    # If the presenting view controller does not respond to rotation events,
+    # then no rotation will be performed.
+    def set_orientation_portrait
+      _set_orientation_portrait
+    end
+
+    # Set the device orientation to landscape.
+    #
+    # In landscape orientation, the display of the device has a bigger height
+    # than width.
+    #
+    # On iOS, the presenting view controller must respond to rotation events.
+    # If the presenting view controller does not respond to rotation events,
+    # then no rotation will be performed.
+    def set_orientation_landscape
+      _set_orientation_landscape
+    end
+
+    # Changes the orientation of the device.
+    #
+    # If the orientation is currently landscape, it will be set to portrait.
+    # If the orientation is currently portrait, it will be set to landscape.
+    #
+    # On iOS, the presenting view controller must respond to rotation events.
+    # If the presenting view controller does not respond to rotation events,
+    # then no rotation will be performed.
+    def change_orientation
+      if portrait?
+        set_orientation_landscape
+      elsif landscape?
+        set_orientation_portrait
+      else
+        raise 'Could not detect current orientation'
+      end
+    end
+
+    # @!visibility private
+    def _portrait?
+      abstract_method!
+    end
+
+    # @!visibility private
+    def _landscape?
+      abstract_method!
+    end
+
+    # @!visibility private
+    def _set_orientation_portrait
+      abstract_method!
+    end
+
+    # @!visibility private
+    def _set_orientation_landscape
+      abstract_method!
+    end
+  end
+end

data/lib/calabash/page.rb

@@ -0,0 +1,35 @@
+module Calabash
+  class Page
+    # For auto-completion
+    include Calabash
+
+    def self.inherited(subclass)
+      # Define the page into global scope
+      name = subclass.to_s.split('::').last
+
+      unless Object.const_defined?(name.to_sym)
+        # We need a unique type for this constant
+        clz = Class.new(StubPage)
+        Object.const_set(name.to_sym, clz)
+      end
+    end
+
+    private_class_method :new
+
+    def initialize(world)
+      @world = world
+    end
+
+    def trait
+      raise 'Implement your own trait'
+    end
+
+    def await(timeout = nil)
+      wait_for_view(trait, timeout: timeout)
+    end
+
+    class StubPage
+
+    end
+  end
+end

data/lib/calabash/patch.rb

@@ -0,0 +1,14 @@
+module Calabash
+  # @!visibility private
+  module Patch
+    require 'calabash/patch/array'
+
+    def self.apply_patches!
+      modules = Patch.constants(false)
+
+      modules.each do |constant|
+        Calabash.const_get(constant).send(:include, const_get(constant))
+      end
+    end
+  end
+end

data/lib/calabash/patch/array.rb

@@ -0,0 +1,16 @@
+module Calabash
+  # @!visibility private
+  module Patch
+
+    # @!visibility private
+    module Array
+      def to_pct
+        if length != 2
+          raise RangeError, "Cannot convert #{self} to {:x, :y} hash"
+        end
+
+        {x: self.[](0), y: self.[](1)}
+      end
+    end
+  end
+end

data/lib/calabash/patch/run_loop.rb

@@ -0,0 +1,90 @@
+require 'run_loop'
+
+if RunLoop.const_defined?(:Ipa)
+  "\033[34mRunLoop::Ipa patch can be removed.\033[0m"
+else
+  "\033[34mApplying RunLoop::Ipa patch.\033[0m"
+
+  # @!visibility private
+  module RunLoop
+    # A model of the an .ipa - a application binary for iOS devices.
+    class Ipa
+
+
+      # The path to this .ipa.
+      # @!attribute [r] path
+      # @return [String] A path to this .ipa.
+      attr_reader :path
+
+      # The bundle identifier of this ipa.
+      # @!attribute [r] bundle_identifier
+      # @return [String] The bundle identifier of this ipa; obtained by inspecting
+      #  the app's Info.plist.
+      attr_reader :bundle_identifier
+
+      # Create a new ipa instance.
+      # @param [String] path_to_ipa The path the .ipa file.
+      # @return [Calabash::Ipa] A new ipa instance.
+      # @raise [RuntimeError] If the file does not exist.
+      # @raise [RuntimeError] If the file does not end in .ipa.
+      def initialize(path_to_ipa)
+        unless File.exist? path_to_ipa
+          raise "Expected an ipa at '#{path_to_ipa}'"
+        end
+
+        unless path_to_ipa.end_with?('.ipa')
+          raise "Expected '#{path_to_ipa}' to be an ipa"
+        end
+        @path = path_to_ipa
+      end
+
+      # @!visibility private
+      def to_s
+        "#<Ipa: #{bundle_identifier}: '#{path}'>"
+      end
+
+      # The bundle identifier of this ipa.
+      # @return [String] A string representation of this ipa's CFBundleIdentifier
+      # @raise [RuntimeError] If ipa does not expand into a Payload/<app name>.app
+      #  directory.
+      # @raise [RuntimeError] If an Info.plist does exist in the .app.
+      def bundle_identifier
+        unless File.exist?(bundle_dir)
+          raise "Expected a '#{File.basename(path).split('.').first}.app'\nat path '#{payload_dir}'"
+        end
+
+        @bundle_identifier ||= lambda {
+          info_plist_path = File.join(bundle_dir, 'Info.plist')
+          unless File.exist? info_plist_path
+            raise "Expected an 'Info.plist' at '#{bundle_dir}'"
+          end
+          pbuddy = RunLoop::PlistBuddy.new
+          pbuddy.plist_read('CFBundleIdentifier', info_plist_path)
+        }.call
+      end
+
+      private
+
+      def tmpdir
+        @tmpdir ||= Dir.mktmpdir
+      end
+
+      def payload_dir
+        @payload_dir ||= lambda {
+          FileUtils.cp(path, tmpdir)
+          zip_path = File.join(tmpdir, File.basename(path))
+          Dir.chdir(tmpdir) do
+            system('unzip', *['-q', zip_path])
+          end
+          File.join(tmpdir, 'Payload')
+        }.call
+      end
+
+      def bundle_dir
+        @bundle_dir ||= lambda {
+          Dir.glob(File.join(payload_dir, '*')).detect {|f| File.directory?(f) && f.end_with?('.app')}
+        }.call
+      end
+    end
+  end
+end