calabash-cucumber 0.9.165 → 0.9.166

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daa55ccad664e8307c21be261ba35f3b46396f15
-  data.tar.gz: c1f1b88c855ab49f2d4abdd694371464e0be1207
+  metadata.gz: 63d73b5e63940ad25b53c4d541e86128843787de
+  data.tar.gz: 0e2c58df0c1137f892fb44ca5efecea534e40a17
 SHA512:
-  metadata.gz: 89923b8b31a848d0ef78fe908ed4d5aaa160ab1d06c6408cfb2b35ea7480994cfaf489e4881e1f6119cab06638f9894cfcc0a28f9e02749c063a3dde69ed8ebe
-  data.tar.gz: 05b5fac88d8cc252a8a3e422f82fa447d7a42454ecd0ca8c49e97440e98a2acc26132902b55f30c795e0d3daf61a7fbd2aa8b35877a9f818a07f34d504f0ac28
+  metadata.gz: 32cafe39cab410dd13ce6865266c39d04925db2d6e86f2504fb211b69f09fac5df01129327b845caaf9c86b76996f345a0dfff902fe74da9ed0b201db2dffd2b
+  data.tar.gz: c6fe8af54e3219a32d6d2811de574bc90e4c0d7201a896103c8215a4a4f81450ba402a9917ccad71696564fa4aeb900d3a8d996602ad64700489eaa5fe85e49f

data/calabash-cucumber.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency( "geocoder", "~>1.1.8")
   s.add_dependency( "httpclient","~> 2.3.3")
   s.add_dependency( "bundler", "~> 1.1")
-  s.add_dependency( "run_loop", "~> 0.1.1" )
+  s.add_dependency( "run_loop", "~> 0.1.2" )
   s.add_dependency( "awesome_print")
   s.add_dependency( "xamarin-test-cloud", "~> 0.9.27")
 

data/lib/calabash-cucumber/core.rb

@@ -39,8 +39,19 @@ module Calabash
         map(uiquery, :query, *args)
       end
 
+      # causes all views matched by the +query+ to briefly change colors making
+      # them visually identifiable.
+      #
+      # returns <tt>[]</tt> if no views are matched
+      #
+      # if there are matching views, returns an array of that contains the
+      # result of calling the objc selector +description+ on each matching view.
+      #
+      # NB: the +args+ argument is ignored and should be deprecated
       def flash(uiquery, *args)
-        map(uiquery, :flash, *args)
+        # todo deprecate the *args argument in the flash method
+        # todo :flash operation should return views as JSON objects
+        map(uiquery, :flash, *args).compact
       end
 
       def server_version
@@ -100,7 +111,6 @@ module Calabash
         launcher.actions.pinch(in_out.to_sym,options)
       end
 
-
       def cell_swipe(options={})
         if uia_available?
           raise 'cell_swipe not supported with instruments, simply use swipe with a query that matches the cell'
@@ -110,15 +120,15 @@ module Calabash
 
       def scroll(uiquery, direction)
         views_touched=map(uiquery, :scroll, direction)
-        screenshot_and_raise "could not find view to scroll: '#{uiquery}', args: #{direction}" if views_touched.empty?
+        msg = "could not find view to scroll: '#{uiquery}', args: #{direction}"
+        assert_map_results(views_touched, msg)
         views_touched
       end
 
       def scroll_to_row(uiquery, number)
         views_touched=map(uiquery, :scrollToRow, number)
-        if views_touched.empty? or views_touched.member? '<VOID>'
-          screenshot_and_raise "Unable to scroll: '#{uiquery}' to: #{number}"
-        end
+        msg = "unable to scroll: '#{uiquery}' to: #{number}"
+        assert_map_results(views_touched, msg)
         views_touched
       end
 
@@ -144,10 +154,8 @@ module Calabash
           args << options[:animate]
         end
         views_touched=map(uiquery, :scrollToRow, row.to_i, sec.to_i, *args)
-
-        if views_touched.empty? or views_touched.member? '<VOID>'
-          screenshot_and_raise "Unable to scroll: '#{uiquery}' to: #{options}"
-        end
+        msg = "unable to scroll: '#{uiquery}' to '#{options}'"
+        assert_map_results(views_touched, msg)
         views_touched
       end
 
@@ -155,6 +163,10 @@ module Calabash
       def scroll_to_row_with_mark(row_id, options={:query => 'tableView',
                                                    :scroll_position => :middle,
                                                    :animate => true})
+        if row_id.nil?
+          screenshot_and_raise 'row_id argument cannot be nil'
+        end
+
         uiquery = options[:query] || 'tableView'
 
         args = []
@@ -168,11 +180,8 @@ module Calabash
         end
 
         views_touched=map(uiquery, :scrollToRowWithMark, row_id, *args)
-
-        if views_touched.empty? or views_touched.member? '<VOID>'
-          msg = options[:failed_message] || "Unable to scroll: '#{uiquery}' to: #{options}"
-          screenshot_and_raise msg
-        end
+        msg = options[:failed_message] || "Unable to scroll: '#{uiquery}' to: #{options}"
+        assert_map_results(views_touched, msg)
         views_touched
       end
 
@@ -268,7 +277,6 @@ module Calabash
         texts
       end
 
-
       def backdoor(sel, arg)
         json = {
               :selector => sel,
@@ -293,6 +301,21 @@ module Calabash
         end
       end
 
+      def server_debug_level
+        _debug_level_response(http(:method => :get, :path => 'debug'))
+      end
+
+      def set_server_debug_level(level)
+        _debug_level_response(http({:method => :post, :path => 'debug'}, {:level => level}))
+      end
+
+      def _debug_level_response(json)
+        res = JSON.parse(json)
+        if res['outcome'] != 'SUCCESS'
+          screenshot_and_raise "debug_level #{json} failed because: #{res['reason']}\n#{res['details']}"
+        end
+        res['results'].first
+      end
       ## args :app for device bundle id, for sim path to app
       ##
       def start_test_server_in_background(args={})
@@ -312,7 +335,6 @@ module Calabash
         stop_test_server
       end
 
-
       def console_attach
         # setting the @calabash_launcher here for backward compatibility
         @calabash_launcher = launcher.attach
@@ -327,7 +349,8 @@ module Calabash
         uiquery, options = extract_query_and_options(uiquery, options)
         views_touched = launcher.actions.send(action, options)
         unless uiquery.nil?
-          screenshot_and_raise "#{action} could not find view: '#{uiquery}', args: #{options}" if views_touched.empty?
+          msg = "#{action} could not find view: '#{uiquery}', args: #{options}"
+          assert_map_results(views_touched, msg)
         end
         views_touched
       end

data/lib/calabash-cucumber/date_picker.rb

@@ -122,12 +122,33 @@ module Calabash
         args
       end
 
-      # expects a DateTime object
-      # notify_targets = true iterates through the target/action pairs and
-      # calls performSelector:<action> object:<target> to simulate a UIEvent
+
+      # sets the date and time on picker identified by <tt>options[:picker_id]</tt>
+      # using the DateTime +target_dt+
+      #
+      # valid options are:
+      #
+      #        :animate - animate the change - default is +true+
+      #      :picker_id - the id (or mark) of the date picker - default is +nil+ which
+      #                   will target the first visible date picker
+      # :notify_targets - notify all objc targets that the date picker has changed
+      #                   default is +true+
+      #
+      # when <tt>:notify_targets = true</tt> this operation iterates through the
+      # target/action pairs on the objc +UIDatePicker+ instance and calls
+      # <tt>performSelector:<action> object:<target></tt> to simulate a +UIEvent+
+      #
+      # raises an error if
+      # * no UIDatePicker can be found
+      # * the target date is greater than the picker's maximum date
+      # * the target date is less than the picker's minimum date
+      # * the target date is not a DateTime object
       def picker_set_date_time (target_dt, options = {:animate => true,
                                                       :picker_id => nil,
                                                       :notify_targets => true})
+        unless target_dt.is_a?(DateTime)
+          raise "target_dt must be a DateTime but found '#{target_dt.class}'"
+        end
 
         picker_id = options == nil ? nil : options[:picker_id]
 
@@ -142,11 +163,8 @@ module Calabash
         query_str = query_string_for_picker picker_id
 
         views_touched = map(query_str, :changeDatePickerDate, target_str, fmt_str, *args)
-
-        if views_touched.empty? or views_touched.member? '<VOID>'
-          screenshot_and_raise "could not change date on picker to '#{target_dt}' using query '#{query_str}' with options '#{options}'"
-        end
-
+        msg = "could not change date on picker to '#{target_dt}' using query '#{query_str}' with options '#{options}'"
+        assert_map_results(views_touched,msg)
         views_touched
       end
     end

data/lib/calabash-cucumber/http_helpers.rb

@@ -92,8 +92,8 @@ module Calabash
       def init_request(options={})
         http = HTTPClient.new
         http.connect_timeout = 30
-        http.send_timeout = 30
-        http.receive_timeout = 30
+        http.send_timeout = 120
+        http.receive_timeout = 120
         if options[:debug] || (ENV['DEBUG_HTTP'] == '1' && options[:debug] != false)
           http.debug_dev = $stdout
         end

data/lib/calabash-cucumber/keyboard_helpers.rb

@@ -230,14 +230,15 @@ module Calabash
             code = UIA_SUPPORTED_CHARS[chr]
 
             unless code
-              raise "Char #{chr} is not yet supported in when typing with Instruments"
+              raise "typing character '#{chr}' is not yet supported when running with Instruments"
             end
 
-            # on iOS 6, the char code is _not_ \b
-            #
-            # as an aside, on iOS 7, the same approach (tap the 'Delete' key) also works
-            if ios6? and code.eql?(UIA_SUPPORTED_CHARS['Delete'])
-              uia("uia.keyboard().keys().firstWithName('Delete').tap()")
+            # on iOS 6, the Delete char code is _not_ \b
+            # on iOS 7, the Delete char code is \b on non-numeric keyboards
+            #           on numeric keyboards, it is actually a button on the
+            #           keyboard and not a key
+            if code.eql?(UIA_SUPPORTED_CHARS['Delete'])
+              uia("uia.keyboard().elements().firstWithName('Delete').tap()")
             else
               uia_type_string(code)
             end
@@ -274,7 +275,7 @@ module Calabash
       def keyboard_enter_text(text)
         _ensure_can_enter_text
         if uia_available?
-          text_before = query("textField isFirstResponder:1",:text).first
+          text_before = _text_from_first_responder()
           uia_type_string(text, text_before)
         else
           text.each_char do |ch|
@@ -287,7 +288,6 @@ module Calabash
         end
       end
 
-
       # touches the keyboard +action+ key
       #
       # the +action+ key depends on the keyboard.  some examples include:
@@ -301,7 +301,7 @@ module Calabash
       # raises an error if the key cannot be entered
       def tap_keyboard_action_key
         if uia_available?
-          uia_type_string '\n'
+          uia_type_string '\n', '', false
         else
           keyboard_enter_char 'Return'
         end
@@ -700,8 +700,7 @@ module Calabash
         unless uia_available?
           screenshot_and_raise 'only available if there is a run_loop i.e. the app was launched with Instruments'
         end
-        # TODO refactor keyboard detection to use uia() function conventions (instead of UIATarget...)
-        res = uia('UIATarget.localTarget().frontMostApp().keyboard()')['value']
+        res = uia_query_windows(:keyboard)
         not res.eql?(':nil')
       end
 
@@ -730,6 +729,29 @@ module Calabash
         end
       end
 
+
+      private
+
+      # returns the the text in the first responder
+      #
+      # the first responder will be the +UITextField+ or +UITextView+ instance
+      # that is associated with the visible keyboard.
+      #
+      # returns +nil+ if there no +textField+ or +testView+ is found to be
+      # the first responder.  it is extremely unlikely that this will happen.
+      #
+      # raises an exception if there is no visible keyboard
+      def _text_from_first_responder
+        raise 'there must be a visible keyboard' unless keyboard_visible?
+
+        ['textField', 'textView'].each do |ui_class|
+          res = query("#{ui_class} isFirstResponder:1", :text)
+          return res.first unless res.empty?
+        end
+        #noinspection RubyUnnecessaryReturnStatement
+        return nil
+      end
+
     end
   end
 end

data/lib/calabash-cucumber/map.rb

@@ -4,10 +4,63 @@ module Calabash
   module Cucumber
     module Map #=> Connection
 
+      # returns an array of views matched by the +query+ or the result of
+      # performing the Objective-C sequence defined by the +method_name+ and
+      # +method_args+ on all the views matched by the +query+
+      #
+      # the query language is documented here: https://github.com/calabash/calabash-ios/wiki
+      #
+      # returns a JSON representation of each view that is matched
+      #
+      # when the +method_name+ is a calabash operation, returns an array that
+      # contains the result of calling the objc selector +description+ on each
+      # matched view.  these are examples of calabash operations: +:flash+,
+      # +:scrollToRowWithMark+, +:changeDatePickerDate+.
       def map(query, method_name, *method_args)
-        raw_map(query,method_name, *method_args)['results']
+        #todo calabash operations should return 'views touched' in JSON format
+        raw_map(query, method_name, *method_args)['results']
       end
 
+      # returns a JSON object the represents the result of performing an http
+      # query against the calabash server.
+      #
+      # gem users should _not_ call this method directly; call +map+ instead.
+      #
+      # raises an error and takes a screenshot if the value of the +outcome+ key
+      # is _not_ 'SUCCESS'
+      #
+      # the JSON object contains the following keys:
+      #
+      #     +outcome+ => indicates the success or failure of the query
+      #
+      #     +status_bar_orientation+ => the orientation of the status bar
+      #
+      #     +results+ => views matched by the +query+ or the result of
+      #                  performing the Objective-C selector sequence defined by
+      #                  the +method_name+ with arguments defined in
+      #                  +method_args+ on all views matched by the +query+
+      #
+      # the query language is documented here: https://github.com/calabash/calabash-ios/wiki
+      #
+      # here are some examples that clarify how the +method_name+ and +method_args+
+      # influence the value of the +results+ key
+      #
+      # simple examples:
+      #
+      #    raw_map('label')['result'] #=> [ all visible UILabels ]
+      #       raw_map('label', :text) #=> [ the 'text' of all visible UILabels ]
+      #
+      # example of calling a selector with arguments:
+      #
+      # <tt>raw_map("tableView marked:'cheeses'", {'numberOfRowsInSection' => 0})) =></tt>
+      # <tt>[ the number of rows in the first section of the 'cheeses' table ]</tt>
+      #
+      # example of calling a selector on view to return an object and then calling
+      # another selector on the returned object:
+      #
+      # <tt>raw_map("pickerView marked:'cheeses'", :delegate, [{pickerView:nil},{titleForRow:1},{forComponent:0}]) =></tt>
+      # objc call: <tt>[[pickerView delegate] pickerView:nil titleForRow:1 forComponent:0] =></tt>
+      # <tt>['French']</tt>
       def raw_map(query, method_name, *method_args)
         operation_map = {
             :method_name => method_name,
@@ -23,6 +76,48 @@ module Calabash
         res
       end
 
+      # asserts the result of a calabash +map+ call and raises an error with
+      # +msg+ if no valid results are found.
+      #
+      # casual gem users should never need to call this method; this is a
+      # convenience method for gem maintainers.
+      #
+      # raises an error if +map_results+:
+      #
+      #              is an empty list #=> []
+      #    contains a '<VOID>' string #=> [ "<VOID>" ]
+      #       contains '*****' string #=> [ "*****"  ]
+      #         contains a single nil #=> [ nil ]
+      #
+      # when evaluating whether a +map+ call is successful it is important to
+      # note that sometimes a <tt>[ nil ]</tt> or <tt>[nil, <val>, nil]</tt> is
+      # a valid result.
+      #
+      # consider a controller with 3 labels:
+      #
+      #    label @ index 0 has text "foo"
+      #    label @ index 1 has text nil (the [label text] => nil)
+      #    label @ index 2 has text "bar"
+      #
+      #    map('label', :text) => ['foo', nil, 'bar']
+      #    map('label index:1', :text) => [nil]
+      #
+      # in other cases, <tt>[ nil ]</tt> should be treated as an invalid result
+      #
+      #    # invalid
+      #    > mark = 'mark does not exist'
+      #    > map('tableView', :scrollToRowWithMark, mark, args) => [ nil ]
+      #
+      # here a <tt>[ nil ]</tt> should be considered invalid because the
+      # the operation could not be performed because there is not row that
+      # matches +mark+
+      def assert_map_results(map_results, msg)
+        compact = map_results.compact
+        if compact.empty? or compact.member? '<VOID>' or compact.member? '*****'
+          screenshot_and_raise msg
+        end
+      end
+
     end
   end
 end

data/lib/calabash-cucumber/operations.rb

@@ -65,22 +65,73 @@ module Calabash
         query(q).map { |e| e['html'] }
       end
 
+      # sets the text value of the views matched by +uiquery+ to +txt+
+      #
+      # @deprecated since 0.9.145
+      #
+      # we have stopped testing this method.  you have been warned.
+      #
+      # * to enter text using the native keyboard use 'keyboard_enter_text'
+      # * to delete text use 'keyboard_enter_text('Delete')"
+      # * to clear a text field or text view:
+      #   - RECOMMENDED: use queries and touches to replicate what the user would do
+      #     - for text fields, implement a clear text button and touch it
+      #     - for text views, use touches to reveal text editing popup
+      #       see https://github.com/calabash/calabash-ios/issues/151
+      #   - use 'clear_text'
+      #  https://github.com/calabash/calabash-ios/wiki/03.5-Calabash-iOS-Ruby-API
+      #
+      # raises an error if the +uiquery+ finds no matching queries or finds
+      # a view that does not respond to the objc selector 'setText'
       def set_text(uiquery, txt)
-        msgs = ["'set_text' will be deprecated.",
+        msgs = ["'set_text' is deprecated and its behavior is now unpredictable",
                 "* to enter text using the native keyboard use 'keyboard_enter_text'",
-                "* to clear a text field or text view use 'clear_text'",
+                "* to delete text use 'keyboard_enter_text('Delete')",
+                '* to clear a text field or text view:',
+                '  - RECOMMENDED: use queries and touches to replicate what the user would do',
+                '    * for text fields, implement a clear text button and touch it',
+                '    * for text views, use touches to reveal text editing popup',
+                '    see https://github.com/calabash/calabash-ios/issues/151',
+                "  - use 'clear_text'",
                 'https://github.com/calabash/calabash-ios/wiki/03.5-Calabash-iOS-Ruby-API']
         msg = msgs.join("\n")
         _deprecated('0.9.145', msg, :warn)
 
         text_fields_modified = map(uiquery, :setText, txt)
-        screenshot_and_raise "could not find text field #{uiquery}" if text_fields_modified.empty?
+
+        msg = "query '#{uiquery}' returned no matching views that respond to 'setText'"
+        assert_map_results(text_fields_modified, msg)
         text_fields_modified
       end
 
+      # sets the text value of the views matched by +uiquery+ to <tt>''</tt>
+      # (the empty string)
+      #
+      # using this sparingly and with caution
+      #
+      #
+      # it is recommended that you instead do some combination of the following
+      #
+      # * use queries and touches to replicate with the user would
+      #   - for text fields, implement a clear text button and touch it
+      #   - for text views, use touches to reveal text editing popup
+      #   see https://github.com/calabash/calabash-ios/issues/151
+      #
+      #  https://github.com/calabash/calabash-ios/wiki/03.5-Calabash-iOS-Ruby-API
+      #
+      # raises an error if the +uiquery+ finds no matching queries or finds
+      # a _single_ view that does not respond to the objc selector 'setText'
+      #
+      # IMPORTANT
+      # calling:
+      #
+      #     > clear_text("view")
+      #
+      # will clear the text on _all_ visible views that respond to 'setText'
       def clear_text(uiquery)
         views_modified = map(uiquery, :setText, '')
-        screenshot_and_raise "could not find text field #{uiquery}" if views_modified.empty?
+        msg = "query '#{uiquery}' returned no matching views that respond to 'setText'"
+        assert_map_results(views_modified, msg)
         views_modified
       end
 

data/lib/calabash-cucumber/uia.rb

@@ -1,5 +1,7 @@
 require 'edn'
 require 'json'
+# required for ruby 1.8
+require 'enumerator'
 
 module Calabash
   module Cucumber
@@ -118,13 +120,18 @@ module Calabash
         uia_handle_command(:screenshot, name)
       end
 
-      def uia_type_string(string, opt_text_before="")
+      def uia_type_string(string, opt_text_before='', escape=true)
+        if escape && string.index(/\\/)
+          indexes = string.enum_for(:scan,/\\/).map { Regexp.last_match.begin(0) }
+          indexes.reverse.each { |idx| string = string.insert(idx, '\\') }
+        end
         res = uia_handle_command(:typeString, string, opt_text_before)
         status = res['status']
         if status.eql?('error')
           value = res['value']
           raise "could not type '#{string}' - '#{value}'"
         end
+        status
       end
 
       def uia_enter

data/lib/calabash-cucumber/version.rb

@@ -1,6 +1,6 @@
 module Calabash
   module Cucumber
-    VERSION = '0.9.165'
-    FRAMEWORK_VERSION = '0.9.164'
+    VERSION = '0.9.166'
+    FRAMEWORK_VERSION = '0.9.166'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calabash-cucumber
 version: !ruby/object:Gem::Version
-  version: 0.9.165
+  version: 0.9.166
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement