calabash-cucumber 0.18.2 → 0.19.0.pre1

data/lib/calabash-cucumber/utils/logging.rb

@@ -1,111 +0,0 @@
-
-module Calabash
-  module Cucumber
-
-    # Internal logging methods for the calabash-ios gem.
-    module Logging
-
-      # @!visibility private
-      # Has full console logging been enabled?
-      #
-      # The return value is controlled by the `CALABASH_FULL_CONSOLE_OUTPUT`
-      # environment variable.
-      #
-      # This is considered one level above debug logging - maybe we should call
-      # the info log level.
-      #
-      # @return [Boolean] Returns `true` if full logging has been enabled.
-      def full_console_logging?
-        ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
-      end
-
-      # @!visibility private
-      # Has debug logging been enabled?
-      #
-      # The return value is controlled by the `DEBUG` environment variable.
-      #
-      # @return [Boolean] Returns `true` if debug logging has been enabled.
-      def debug_logging?
-        ENV['DEBUG'] == '1'
-      end
-
-      # Prints a blue warning message.
-      # @param [String] msg the message to print
-      # @return [void]
-      def calabash_warn(msg)
-        begin
-          warn "\033[34m\nWARN: #{msg}\033[0m"
-        rescue
-          warn "\nWARN: #{msg}"
-        end
-      end
-
-      # Prints a green info message.
-      # @param [String] msg the message to print
-      # @return [void]
-      def calabash_info(msg)
-        begin
-          puts "\033[32m\nINFO: #{msg}\033[0m"
-        rescue
-          puts "\nINFO: #{msg}"
-        end
-      end
-
-      # @!visibility private
-      # Controls printing of deprecation warnings.
-      #
-      # To inhibit deprecation message set this to '1'
-      #
-      # Inhibiting deprecation messages is not recommend.
-      CALABASH_NO_DEPRECATION = ENV['CALABASH_NO_DEPRECATION'] || '0'
-
-      # @!visibility private
-      # Have deprecation warnings been turned off?
-      #
-      # The return value is controlled but the `CALABASH_NO_DEPRECATION`
-      # environment variable.
-      def no_deprecation_warnings?
-        ENV['CALABASH_NO_DEPRECATION'] == '1'
-      end
-
-      # @!visibility private
-      # Prints a deprecated message that includes the line number.
-      #
-      # If deprecation warns have been turned off this method does nothing.
-      #
-      # @param [String] version indicates when the feature was deprecated
-      # @param [String] msg deprecation message (possibly suggesting alternatives)
-      # @param [Symbol] type { :warn | :pending } - :pending will raise a
-      #   cucumber pending error
-      # @return [void]
-      def _deprecated(version, msg, type)
-        allowed = [:pending, :warn]
-        unless allowed.include?(type)
-          raise "type '#{type}' must be on of '#{allowed}'"
-        end
-
-        unless no_deprecation_warnings?
-
-          if RUBY_VERSION < '2.0'
-            stack = Kernel.caller()[1..6].join("\n")
-          else
-            stack = Kernel.caller(0, 6)[1..-1].join("\n")
-          end
-
-          msg = "deprecated '#{version}' - #{msg}\n#{stack}"
-
-          if type.eql?(:pending)
-            pending(msg)
-          else
-            begin
-              warn "\033[34m\nWARN: #{msg}\033[0m"
-            rescue
-              warn "\nWARN: #{msg}"
-            end
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/calabash-cucumber/utils/plist_buddy.rb

@@ -1,45 +0,0 @@
-require 'run_loop'
-
-module Calabash
-  module Cucumber
-    # @!visibility private
-    # A module for reading and writing property list values.
-    module PlistBuddy
-
-      # Reads key from file and returns the result.
-      # @param [String] key the key to inspect (may not be nil or empty)
-      # @param [String] file the plist to read
-      # @param [Hash] opts options for controlling execution
-      # @option opts [Boolean] :verbose (false) controls log level
-      # @return [String] the value of the key
-      # @raise [ArgumentError] if nil or empty key
-      def plist_read(key, file, opts={})
-        RunLoop::PlistBuddy.new.plist_read(key, file, opts)
-      end
-
-      # Checks if the key exists in plist.
-      # @param [String] key the key to inspect (may not be nil or empty)
-      # @param [String] file the plist to read
-      # @param [Hash] opts options for controlling execution
-      # @option opts [Boolean] :verbose (false) controls log level
-      # @return [Boolean] true if the key exists in plist file
-      def plist_key_exists?(key, file, opts={})
-        plist_read(key, file, opts) != nil
-      end
-
-      # Replaces or creates the value of key in the file.
-      #
-      # @param [String] key the key to set (may not be nil or empty)
-      # @param [String] type the plist type (used only when adding a value)
-      # @param [String] value the new value
-      # @param [String] file the plist to read
-      # @param [Hash] opts options for controlling execution
-      # @option opts [Boolean] :verbose (false) controls log level
-      # @return [Boolean] true if the operation was successful
-      # @raise [ArgumentError] if nil or empty key
-      def plist_set(key, type, value, file, opts={})
-        RunLoop::PlistBuddy.new.plist_set(key, type, value, file, opts)
-      end
-    end
-  end
-end

data/lib/calabash-cucumber/utils/simulator_accessibility.rb

@@ -1,334 +0,0 @@
-require 'calabash-cucumber/utils/xctools'
-require 'calabash-cucumber/utils/plist_buddy'
-require 'calabash-cucumber/utils/logging'
-require 'sim_launcher'
-require 'cfpropertylist'
-require 'run_loop'
-
-module Calabash
-  module Cucumber
-
-    # @deprecated 0.10.0 Replaced with RunLoop::SimControl
-    # Public methods for common simulator tasks and private methods for
-    # enabling accessibility on the simulator.
-    module SimulatorAccessibility
-
-      include Calabash::Cucumber::XcodeTools
-      include Calabash::Cucumber::PlistBuddy
-
-      # Quits the iOS Simulator.
-      #
-      # ATM there can only be only simulator open at a time, so simply doing
-      # what the sim_launcher gem does:
-      #
-      # ```
-      # def quit_simulator
-      #   `echo 'application "iPhone Simulator" quit' | osascript`
-      # end
-      # ```
-      #
-      # works.  I am not sure if we will ever be able to launch more than one
-      # simulator, but in case we can, this method will quit the simulator
-      # that is indicated by `xcode-select` or `DEVELOPER_DIR`.
-      def quit_simulator
-        RunLoop::SimControl.new.quit_sim
-      end
-
-      # Launches the iOS Simulator indicated by `xcode-select` or `DEVELOPER_DIR`.
-      def launch_simulator
-        RunLoop::SimControl.new.launch_sim
-      end
-
-      # Resets the simulator content and settings.  It is analogous to touching
-      # the menu item.
-      #
-      # It works by deleting the following directories:
-      #
-      # * ~/Library/Application Support/iPhone Simulator/Library
-      # * ~/Library/Application Support/iPhone Simulator/Library/<sdk>[-64]
-      #
-      # and relaunching the iOS Simulator which will recreate the Library
-      # directory and the latest SDK directory.
-      def reset_simulator_content_and_settings
-        quit_simulator
-        sim_lib_path = File.join(simulator_app_support_dir(), 'Library')
-        FileUtils.rm_rf(sim_lib_path)
-        existing_simulator_support_sdk_dirs.each do |dir|
-          FileUtils.rm_rf(dir)
-        end
-
-        launch_simulator
-
-        # this is tricky because we need to wait for the simulator to recreate
-        # the directories.  specifically, we need the Accessibility plist to be
-        # exist so subsequent calabash launches will be able to enable
-        # accessibility.
-        #
-        # the directories take ~3.0 - ~5.0 to create.
-        counter = 0
-        loop do
-          break if counter == 80
-          dirs = existing_simulator_support_sdk_dirs
-          if dirs.count == 0
-            sleep(0.2)
-          else
-            break if dirs.all? { |dir|
-              plist = File.expand_path("#{dir}/Library/Preferences/com.apple.Accessibility.plist")
-              File.exists?(plist)
-            }
-            sleep(0.2)
-          end
-          counter = counter + 1
-        end
-      end
-
-      # @deprecated 0.10.0 replaced with RunLoop::SimControl#enable_accessibility_on_simulators
-      # @!visibility private
-      # Enables accessibility on any existing iOS Simulator by adjusting the
-      # simulator's Library/Preferences/com.apple.Accessibility.plist contents.
-      #
-      # A simulator 'exists' if has an Application Support directory. for
-      # example, the 6.1, 7.0.3-64, and 7.1 simulators exist if the following
-      # directories are present:
-      #
-      #     ~/Library/Application Support/iPhone Simulator/Library/6.1
-      #     ~/Library/Application Support/iPhone Simulator/Library/7.0.3-64
-      #     ~/Library/Application Support/iPhone Simulator/Library/7.1
-      #
-      # A simulator is 'possible' if the SDK is available in the Xcode version.
-      #
-      # This method merges (uniquely) the possible and existing SDKs.
-      #
-      # This method also hides the AXInspector.
-      #
-      # @param [Hash] opts controls the behavior of the method
-      # @option opts [Boolean] :verbose controls logging output
-      # @return [Boolean] true if enabling accessibility worked on all sdk
-      #  directories
-      def enable_accessibility_on_simulators(opts={})
-        _deprecated('0.10.0', 'replaced with RunLoop::SimControl#enable_accessibility_on_simulators', :warn)
-        possible = possible_simulator_support_sdk_dirs
-        existing = existing_simulator_support_sdk_dirs
-        dirs = (possible + existing).uniq
-        results = dirs.map do |dir|
-          enable_accessibility_in_sdk_dir(dir, opts)
-        end
-        results.all? { |elm| elm }
-      end
-
-      @private
-
-      # @deprecated 0.10.0 no replacement
-      # @!visibility private
-      # Enables accessibility on the simulator indicated by `sim_app_support_sdk_dir.`
-      #
-      # @note  This will quit the simulator.
-      #
-      # @example
-      #   path = '/6.1'
-      #   enable_accessibility_in_sdk_dir(path)
-      #
-      # This method also hides the AXInspector.
-      #
-      # If the Library/Preferences/com.apple.Accessibility.plist does not exist
-      # this method will create a Library/Preferences/com.apple.Accessibility.plist
-      # that (oddly) the Simulator will _not_ overwrite.
-      #
-      # @see enable_accessibility_on_simulators for the public API.
-      #
-      # @param [String] sim_app_support_sdk_dir the directory where the
-      #   Library/Preferences/com.apple.Accessibility.plist can be found.
-      #
-      # @param [Hash] opts controls the behavior of the method
-      # @option opts [Boolean] :verbose controls logging output
-      # @return [Boolean] if the plist exists and the plist was successfully
-      #   updated.
-      def enable_accessibility_in_sdk_dir(sim_app_support_sdk_dir, opts={})
-        _deprecated('0.10.0', 'no replacement', :warn)
-        default_opts = {:verbose => false}
-        merged = default_opts.merge(opts)
-
-        quit_simulator
-
-        verbose = merged[:verbose]
-        sdk = File.basename(sim_app_support_sdk_dir)
-        msgs = ["cannot enable accessibility for #{sdk} SDK"]
-
-        plist_path = File.expand_path("#{sim_app_support_sdk_dir}/Library/Preferences/com.apple.Accessibility.plist")
-
-        hash = accessibility_properties_hash()
-
-        if File.exist?(plist_path)
-          res = hash.map do |hash_key, settings|
-            success = plist_set(settings[:key], settings[:type], settings[:value], plist_path)
-            unless success
-              if verbose
-                if settings[:type] == 'bool'
-                  value = settings[:value] ? 'YES' : 'NO'
-                else
-                  value = settings[:value]
-                end
-                msgs << "could not set #{hash_key} => '#{settings[:key]}' to #{value}"
-                calabash_warn(msgs.join("\n"))
-              end
-            end
-            success
-          end
-          res.all? { |elm| elm }
-        else
-          FileUtils.mkdir_p("#{sim_app_support_sdk_dir}/Library/Preferences")
-          plist = CFPropertyList::List.new
-          data = {}
-          # CFPropertyList gem is super wonky
-          # it matches Boolean to a string type with 'true/false' values
-          # - stick with PlistBuddy
-          # hash.each do |_, settings|
-          #   data[settings[:key]] = settings[:value]
-          # end
-          plist.value = CFPropertyList.guess(data)
-          plist.save(plist_path, CFPropertyList::List::FORMAT_BINARY)
-          enable_accessibility_in_sdk_dir(sim_app_support_sdk_dir)
-        end
-      end
-
-
-      # @deprecated 0.10.0 no replacement
-      # @!visibility private
-      # A hash table of the accessibility properties that control whether or not
-      # accessibility is enabled and whether the AXInspector is visible.
-      # @return [Hash] table of accessibility properties found in the
-      #  Library/Preferences/com.apple.Accessibility.plist
-      def accessibility_properties_hash
-        _deprecated('0.10.0', 'no replacement', :warn)
-        {
-              # this is required
-              :access_enabled => {:key => 'AccessibilityEnabled',
-                                  :value => 'true',
-                                  :type => 'bool'},
-              # i _think_ this is legacy
-              :app_access_enabled => {:key => 'ApplicationAccessibilityEnabled',
-                                      :value => 'true',
-                                      :type => 'bool'},
-
-              # i don't know what this does
-              :automation_enabled => {:key => 'AutomationEnabled',
-                                      :value => 'true',
-                                      :type => 'bool'},
-
-              # determines if the Accessibility Inspector is showing
-              :inspector_showing => {:key => 'AXInspectorEnabled',
-                                     :value => 'false',
-                                     :type => 'bool'},
-
-              # controls if the Accessibility Inspector is expanded or not expanded
-              :inspector_full_size => {:key => 'AXInspector.enabled',
-                                       :value => 'false',
-                                       :type => 'bool'},
-
-              # controls the frame of the Accessibility Inspector
-              # this is a 'string' => {{0, 0}, {276, 166}}
-              :inspector_frame => {:key => 'AXInspector.frame',
-                                   :value => '{{270, -13}, {276, 166}}',
-                                   :type => 'string'}
-        }
-      end
-
-      # @deprecated 0.10.0 no replacement
-      # @!visibility private
-      # The absolute path to the iPhone Simulator Application Support directory.
-      # @return [String] absolute path
-      # @todo add deprecation message - ATM {Calabash::Cucumber::Launcher.reset_app_sandbox} is using this
-      def simulator_app_support_dir
-        File.expand_path('~/Library/Application Support/iPhone Simulator')
-      end
-
-      # @deprecated 0.10.0 no replacement
-      # @!visibility private
-      # The absolute path to the SDK's com.apple.Accessibility.plist file.
-      # @param [String] sdk_dir base path the SDK directory
-      # @return [String] an absolute path
-      def plist_path_with_sdk_dir(sdk_dir)
-        _deprecated('0.10.0', 'no replacement', :warn)
-        File.expand_path("#{sdk_dir}/Library/Preferences/com.apple.Accessibility.plist")
-      end
-
-      # @deprecated 0.10.0 no replacement
-      # @!visibility private
-      # Returns a list of absolute paths the existing simulator directories.
-      #
-      # A simulator 'exists' if has an Application Support directory. for
-      # example, the 6.1, 7.0.3-64, and 7.1 simulators exist if the following
-      # directories are present:
-      #
-      #     ~/Library/Application Support/iPhone Simulator/Library/6.1
-      #     ~/Library/Application Support/iPhone Simulator/Library/7.0.3-64
-      #     ~/Library/Application Support/iPhone Simulator/Library/7.1
-      #
-      # @return[Array<String>] a list of absolute paths to simulator directories
-      # @todo add deprecation message - ATM ::reset_content_and_settings is using this
-      def existing_simulator_support_sdk_dirs
-        sim_app_support_path = simulator_app_support_dir()
-        Dir.glob("#{sim_app_support_path}/*").select { |path|
-          path =~ /(\d)\.(\d)\.?(\d)?(-64)?/
-        }
-      end
-
-      # @deprecated 0.10 no replacement
-      # @!visibility private
-      # Returns a list of possible SDKs per Xcode version.
-      #
-      # It is not enough to ask for the available sdks because of the new 64-bit
-      # variants that started to appear Xcode 5 and the potential for patch level
-      # versions.
-      #
-      # Unfortunately, this method will need be maintained per Xcode version.
-      #
-      # @return [Array<String>] ex. ['6.1', '7.1', '7.0.3', '7.0.3-64']
-      def possible_simulator_sdks
-        _deprecated('0.10.0', 'no replacement', :warn)
-        sdk_detector = SimLauncher::SdkDetector.new
-        available = sdk_detector.available_sdk_versions
-        instruments_version = instruments(:version)
-
-        # in Xcode 5.1* SDK 7.0 ==> 7.0.3
-        if (instruments_version == '5.1' or instruments_version == '5.1.1') and available.include?('7.0')
-          available << '7.0.3'
-          available << '7.0.3-64'
-        end
-
-        if instruments_version == '5.1.1' and available.include?('7.1')
-          available << '7.1'
-          available << '7.1-64'
-        end
-
-        gem_compat_xcode_versions = ['5.1', '5.1.1']
-        unless gem_compat_xcode_versions.include?(instruments_version)
-          msg = ["expected Xcode instruments version to be '5.1' or '5.1.1'",
-                 "but found version '#{instruments_version}'",
-                 "Gem needs a manual update for Xcode #{instruments_version}!"].join("\n")
-          calabash_warn(msg)
-        end
-
-        # in Xcode 5.1* SDK 7.0 ==> 7.0.3 so we should not include '7.0'
-        # if the user's support directory already contains a 7.0 and 7.0-64 dir
-        # we will detect it by reading from disk.
-        (available - ['7.0']).uniq.sort
-      end
-
-      # @deprecated 0.10.0 no replacement
-      # @!visibility private
-      # Return absolute paths to possible simulator support sdk dirs.
-      #
-      # these directories may or may not exist
-      # @return [Array<String>] an array of absolute paths
-      def possible_simulator_support_sdk_dirs
-        _deprecated('0.10.0', 'no replacement', :warn)
-        base_dir = simulator_app_support_dir
-        possible_simulator_sdks.map { |sdk|
-          "#{base_dir}/#{sdk}"
-        }
-      end
-
-    end
-  end
-end