briar 0.1.2 → 0.1.3.b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93314dd49766ff68b61036af263bdb9493a37ae9
-  data.tar.gz: a8caf27e07199bdcf4e5d954d190649ecd7d6d44
+  metadata.gz: 5231e29949bd6dce316e46e8892b0b5785307430
+  data.tar.gz: 259b97c2bf9bb0ec0f32854c5255b2792469fb3f
 SHA512:
-  metadata.gz: 368c8b7088534f878a18ab4aad6f2150d42804f9eccf18da6a8f3eaed2adeca9ac38a0278486209b797aacb580fd2be316d44074576cd32a9b5979968918fb8d
-  data.tar.gz: 78c34ffbf187dcc6a773937b9f6c4fb819a51fe32117e387a66ee7c8779477540f75c6f360eaf158bbd85ec599ceb2f093f0dcf00ba0796cea7aaad137618727
+  metadata.gz: 99d23ae36a4b4a2dd0f896435b402edcaaf4e3ab9f554597cc2b46664f2d0642f277e7f6cf81afb9e5ad9bc5f0670688412262d987a3230cd37b29cd8ea904c6
+  data.tar.gz: af09c628255dc79dc9e1d828fa1deaff33c5e157d2ee389e453d152290e175a65e12974805053849dff0809cd3752a8f019aded849192f1f349246d3972fb850

data/briar.gemspec

@@ -5,21 +5,21 @@ $:.push File.expand_path('../lib', __FILE__)
 require 'briar/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = 'briar'
-  gem.version       = Briar::VERSION
-  gem.authors       = ['Joshua Moody']
-  gem.email         = ['joshuajmoody@gmail.com']
-  gem.description   = 'extends calabash-ios steps'
-  gem.summary       = "briar-#{gem.version}"
-  gem.homepage      = 'https://github.com/jmoody/briar'
-  gem.license       = 'MIT'
+  gem.name = 'briar'
+  gem.version = Briar::VERSION
+  gem.authors = ['Joshua Moody']
+  gem.email = ['joshuajmoody@gmail.com']
+  gem.description = 'extends calabash-ios steps'
+  gem.summary = "briar-#{gem.version}"
+  gem.homepage = 'https://github.com/jmoody/briar'
+  gem.license = 'MIT'
 
   gem.add_runtime_dependency 'calabash-cucumber'
   gem.add_runtime_dependency 'rake'
-  gem.add_runtime_dependency 'syntax' 
+  gem.add_runtime_dependency 'syntax'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = 'briar'
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = 'briar'
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 end

data/features/step_definitions/alerts_and_sheets/action_sheet_steps.rb

@@ -2,8 +2,8 @@ Then /^I touch the "([^"]*)" button on the action sheet$/ do |button_title|
   timeout = 1.0
   msg = "waited for '#{timeout}' seconds but did not see sheet with button '#{button_title}'"
   options = {:timeout => timeout,
-             :retry_frequency => BRIAR_RETRY_FREQ,
-             :post_timeout => BRIAR_POST_TIMEOUT,
+             :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+             :post_timeout => BRIAR_WAIT_STEP_PAUSE,
              :timeout_message => msg}
   wait_for(options) do
     not query('actionSheet').empty?

data/features/step_definitions/bars/tabbar_steps.rb

@@ -1,15 +1,3 @@
-
-Given /^that the tabbar is visible$/ do
-  pending "deprecated 0.0.5 - use 'Then I should see the tabbar'"
-  should_see_tabbar
-end
-
-Then /^the tabbar is visible$/ do
-  pending "deprecated 0.0.5 - use 'Then I should see the tabbar'"
-  should_see_tabbar
-end
-
-
 Then /^I should( not)? see the (?:tabbar|tab bar)$/ do |visibility|
   visibility ? should_not_see_tabbar : should_see_tabbar
 end

data/features/step_definitions/control/segmented_control_steps.rb

@@ -15,7 +15,7 @@ end
 ### deprecated - will remove in future versions ####
 
 Then /^I should see the segment I touched (is|is not) selected and the "([^"]*)" should be set correctly$/ do |selectedness, label_id|
-  pending('deprecated 0.1.1 - no replacement')
+  deprecated('0.1.1', 'no replacement', :pending)
   #@associated_label = label_id
   #should_see_segment_with_selected_state @control_id, @segment_id, selectedness.eql?('is') ? 1 : 0
   ## unexpected!
@@ -25,19 +25,19 @@ Then /^I should see the segment I touched (is|is not) selected and the "([^"]*)"
 end
 
 Then /^I touch the segment again$/ do
-  pending('deprecated 0.1.1 - no replacement')
+  deprecated('0.1.1', 'no replacement', :pending)
   #touch_segment @segment_id, @control_id
 end
 
 Then /^I should see the segment is not selected and the detail label is cleared$/ do
-  pending('deprecated 0.1.1 - no replacement')
+  deprecated('0.1.1', 'no replacement', :pending)
   ## ugh - that @associated_label variable needs to be set
   #macro %Q|I should see segment "#{@segment_id}" in segmented control "#{@control_id}" is not selected|
   #macro %Q|I should see label "#{@associated_label}" with text ""|
 end
 
 Then /^I should see the segment I touched (is|is not) selected and the "([^"]*)" in the "([^"]*)" row should be set correctly$/ do |selectedness, label_id, row_id|
-  pending('deprecated 0.1.1 - no replacement')
+  deprecated('0.1.1', 'no replacement', :pending)
   ## ugh - that @associated_label variable needs to be set
   #@associated_label = label_id
   #@associated_row = row_id
@@ -46,7 +46,7 @@ Then /^I should see the segment I touched (is|is not) selected and the "([^"]*)"
 end
 
 Then /^I should see the segment is not selected and the label in the row is cleared$/ do
-  pending('deprecated 0.1.1 - no replacement')
+  deprecated('0.1.1', 'no replacement', :pending)
   ## ugh - difficult to extract to a function because we need the
   ## @associated_row and @associated_label to be set
   #macro %Q|I should see segment "#{@segment_id}" in segmented control "#{@control_id}" is not selected|

data/features/step_definitions/email_steps.rb

@@ -1,9 +1,3 @@
-
-#noinspection RubyUnusedLocalVariable
-Then /^I should see email body that contains "([^"]*)"$/ do |text|
-  pending "deprecated 0.0.6 - use 'Then I should see email view with body that contains \"#{text}\"'"
-end
-
 Then /^I should see email view with body that contains "([^"]*)"$/ do |text|
   if not device.ios5?
     warn_about_no_ios5_email_view

data/features/step_definitions/keyboard_steps.rb

@@ -1,4 +1,3 @@
-
 Then /^I should see the keyboard$/ do
   should_see_keyboard
 end
@@ -20,11 +19,11 @@ end
 
 
 Then /^I touch the delete key$/ do
-  keyboard_enter_char 'Delete'
+  briar_keyboard_send_backspace
 end
 
 Then(/^I turn off spell checking and capitalization$/) do
-  pending('deprecated 0.1.1 - not working')
+  deprecated('0.1.1', 'not working', :pending)
   #should_see_keyboard
   #turn_autocapitalization_off
   #turn_autocorrect_off

data/features/step_definitions/picker/date_picker_steps.rb

@@ -32,13 +32,6 @@ Then /^I change the picker to (\d+) days? ago at "([^"]*)"$/ do |days_ago, targe
   change_time_on_picker_with_time_str target_time
 end
 
-
-#noinspection RubyUnusedLocalVariable
-Then /^I change the picker date time to "([^"]*)"$/ do |target_time|
-  pending 'deprecated 0.0.6 - not replaced with anything'
-end
-
-
 Then /^I should see that the date picker is in (time|date|date and time) mode$/ do |mode|
   if mode.eql? 'time'
     unless picker_is_in_time_mode

data/features/step_definitions/scroll_view_steps.rb

@@ -1,10 +1,3 @@
-
-
-#noinspection RubyUnusedLocalVariable
-Then /^I scroll (left|right|up|down) until I see "([^\"]*)" limit (\d+)$/ do |dir, marker, limit|
-  pending "deprecated 0.0.6 - use Then I scroll #{dir} until I see \"#{marker}\""
-end
-
 Then /^I scroll (left|right|up|down) until I see "([^\"]*)"$/ do |dir, marker|
   wait_poll({:until_exists => "view marked:'#{marker}'",
              :timeout => 2}) do

data/features/step_definitions/table_steps.rb

@@ -7,17 +7,6 @@ Then(/^I scroll to the "([^"]*)" row$/) do |row_id|
   briar_scroll_to_row row_id
 end
 
-#noinspection RubyUnusedLocalVariable
-Then /^I scroll (left|right|up|down) until I see the "([^\"]*)" row limit (\d+)$/ do |dir, row_id, limit|
-  pending "deprecated 0.0.6 - use 'Then I scroll to the \"#{row_id}\" row'"
-end
-
-
-#noinspection RubyUnusedLocalVariable
-Then /^I scroll (left|right|up|down) until I see (?:the|an?) "([^\"]*)" row$/ do |dir, row_id|
-  pending "deprecated 0.0.8 - use 'Then I scroll to the \"#{row_id}\" row'"
-end
-
 Then /^I touch (?:the) "([^"]*)" row and wait for (?:the) "([^"]*)" view to appear$/ do |row_id, view_id|
   wait_for_row row_id
   step_pause
@@ -139,7 +128,7 @@ Then /^I should see a detail disclosure chevron in the "([^"]*)" row$/ do |row_i
 end
 
 Then /^I touch the "([^"]*)" switch in the "([^"]*)" row$/ do |switch_id, row_id|
-  warn 'WARN: deprecated 0.1.1 - write a custom step'
+  deprecated('0.1.1', 'write a custom step', :warn)
   touch_switch_in_row switch_id, row_id
 end
 

data/lib/briar.rb

@@ -2,23 +2,38 @@
 
 DEVICE_ENDPOINT = (ENV['DEVICE_ENDPOINT'] || 'http://localhost:37265')
 
-# deprecate these #
+# will deprecate soon
 TOUCH_TRANSITION_TIMEOUT = 30.0
 TOUCH_TRANSITION_RETRY_FREQ = 0.5
+ANIMATION_PAUSE = (ENV['ANIMATION_PAUSE'] || 0.6).to_f
+
+# see below for replacements
+BRIAR_RETRY_FREQ=0.1
+BRIAR_POST_TIMEOUT=0.5
 ##################
 
 BRIAR_STEP_PAUSE = (ENV['STEP_PAUSE'] || 0.5).to_f
-BRIAR_WAIT_TIMEOUT = (ENV['WAIT_TIMEOUT'] || 4.0).to_f
-BRIAR_RETRY_FREQ = (ENV['RETRY_FREQ'] || 0.1).to_f
-BRIAR_POST_TIMEOUT = (ENV['POST_TIMEOUT'] || 0.2).to_f
-
-ANIMATION_PAUSE = (ENV['ANIMATION_PAUSE'] || 0.6).to_f
+# we need an insanely long time out because of some changes in 0.9.163
+# the waits succeed after a short amount of time (visually < 1 sec),
+# but fail if the wait time out is too short (4s)
+# 8 seconds works most of the time
+# 10 seconds seems safe
+# the problem with a long time out is that during development you want the
+# tests to fail fast.
+BRIAR_WAIT_TIMEOUT = (ENV['WAIT_TIMEOUT'] || 14.0).to_f
+BRIAR_WAIT_RETRY_FREQ = (ENV['RETRY_FREQ'] || 0.1).to_f
+
+# 'post timeout' is the time to wait after a wait function returns true
+# i think 'wait step pause' is a better variable name
+BRIAR_WAIT_STEP_PAUSE = (ENV['POST_TIMEOUT'] || 0.5).to_f
 
 #noinspection RubyConstantNamingConvention
 AI = :accessibilityIdentifier
 #noinspection RubyConstantNamingConvention
 AL = :accessibilityLabel
 
+require 'calabash-cucumber'
+
 require 'briar/version'
 require 'briar/briar_core'
 require 'briar/briar_uia'
@@ -42,7 +57,8 @@ require 'briar/picker/date_picker'
 
 require 'briar/email'
 require 'briar/image_view'
-require 'briar/keyboard'
+require 'briar/keyboard/keyboard'
+require 'briar/keyboard/uia_keyboard'
 require 'briar/label'
 require 'briar/scroll_view'
 
@@ -50,6 +66,7 @@ require 'briar/table'
 require 'briar/text_field'
 require 'briar/text_view'
 
+
 #noinspection RubyDefParenthesesInspection
 def device ()
   url = URI.parse(ENV['DEVICE_ENDPOINT']|| 'http://localhost:37265/')
@@ -72,9 +89,21 @@ def device ()
   end
 end
 
-#noinspection RubyDefParenthesesInspection
-def gestalt ()
-  pending("deprecated 0.0.8: replaced with Calabash::Cucumber::Device implementation - from now on use use 'device.*'")
+# todo deprecated function needs file + line numbers
+# todo deprecated function does not output on a new line when called within cucumber
+def deprecated(version, msg, type)
+  allowed = [:pending, :warn]
+  unless allowed.include?(type)
+    screenshot_and_raise "type '#{type}' must be on of '#{allowed}'"
+  end
+
+  msg = "deprecated '#{version}' - '#{msg}'"
+
+  if type.eql?(:pending)
+    pending(msg)
+  else
+    warn "\nWARN: #{msg}"
+  end
 end
 
 
@@ -82,3 +111,5 @@ end
 
 
 
+
+

data/lib/briar/alerts_and_sheets/action_sheet.rb

@@ -1,3 +1,4 @@
+require 'calabash-cucumber'
 module Briar
   module Alerts_and_Sheets
 
@@ -36,9 +37,9 @@ module Briar
     def wait_for_sheet (sheet_id, timeout=BRIAR_WAIT_TIMEOUT)
       msg = "waited for '#{timeout}' seconds but did not see '#{sheet_id}'"
       wait_for(:timeout => timeout,
-               :retry_frequency => BRIAR_RETRY_FREQ,
-               :post_timeout => BRIAR_POST_TIMEOUT,
-               :timeout_message => msg ) do
+               :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+               :post_timeout => BRIAR_WAIT_STEP_PAUSE,
+               :timeout_message => msg) do
         sheet_exists? sheet_id
       end
     end
@@ -46,8 +47,8 @@ module Briar
     def wait_for_sheet_to_disappear(sheet_id, timeout=BRIAR_WAIT_TIMEOUT)
       msg = "waited for '#{timeout}' seconds for '#{sheet_id}' to disappear but it is still visible"
       options = {:timeout => timeout,
-                 :retry_frequency => BRIAR_RETRY_FREQ,
-                 :post_timeout => BRIAR_POST_TIMEOUT,
+                 :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+                 :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                  :timeout_message => msg}
       wait_for(options) do
         not sheet_exists? sheet_id

data/lib/briar/alerts_and_sheets/alert_view.rb

@@ -1,3 +1,5 @@
+require 'calabash-cucumber'
+
 module Briar
   module Alerts_and_Sheets
 
@@ -7,7 +9,7 @@ module Briar
 
     def alert_exists? (alert_id=nil)
       if device.ios7?
-        res = send_uia_command command:'uia.alert() != null'
+        res = send_uia_command command: 'uia.alert() != null'
         res['value']
       else
         if alert_id.nil?
@@ -41,16 +43,16 @@ module Briar
     def should_see_alert_with_title (title, timeout=BRIAR_WAIT_TIMEOUT)
       if device.ios7?
         warn 'WARN: cannot distinguish between alert titles and messages'
-        should_see_alert()
-        if uia_query(:view, marked:"#{title}").empty?
+        should_see_alert
+        if uia_query(:view, marked: "#{title}").empty?
           screenshot_and_raise "expected to see alert with title '#{title}'"
         end
       else
         qstr = 'alertView child label'
         msg = "waited for '#{timeout}' for alert with title '#{title}'"
         wait_for(:timeout => timeout,
-                 :retry_frequency => BRIAR_RETRY_FREQ,
-                 :post_timeout => BRIAR_POST_TIMEOUT,
+                 :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+                 :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                  :timeout_message => msg) do
           query(qstr, :text).include?(title)
         end
@@ -61,15 +63,15 @@ module Briar
       if device.ios7?
         warn 'WARN: cannot distinguish between alert titles and messages'
         should_see_alert
-        if uia_query(:view, marked:"#{message}").empty?
+        if uia_query(:view, marked: "#{message}").empty?
           screenshot_and_raise "expected to see alert with title '#{message}'"
         end
       else
         qstr = 'alertView child label'
         msg = "waited for '#{timeout}' for alert with message '#{message}'"
         wait_for(:timeout => timeout,
-                 :retry_frequency => BRIAR_RETRY_FREQ,
-                 :post_timeout => BRIAR_POST_TIMEOUT,
+                 :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+                 :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                  :timeout_message => msg) do
           query(qstr, :text).include?(message)
         end
@@ -78,8 +80,8 @@ module Briar
 
     def alert_button_exists? (button_id)
       if device.ios7?
-        should_see_alert()
-        not uia_query(:view, marked:"#{button_id}").empty?
+        should_see_alert
+        not uia_query(:view, marked: "#{button_id}").empty?
       else
         query('alertView child button child label', :text).include?(button_id)
       end
@@ -102,7 +104,7 @@ module Briar
 
 
     def touch_alert_button(button_title)
-      should_see_alert()
+      should_see_alert
       if device.ios7?
         touch("view marked:'#{button_title}'")
       else

data/lib/briar/bars/navbar.rb

@@ -26,8 +26,8 @@ module Briar
       timeout = BRIAR_WAIT_TIMEOUT * 2.0
       msg = "waited for '#{timeout}' seconds but did not see navbar back button"
       wait_for(:timeout => timeout,
-               :retry_frequency => BRIAR_RETRY_FREQ,
-               :post_timeout => BRIAR_POST_TIMEOUT,
+               :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+               :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                :timeout_message => msg) do
         navbar_has_back_button?
       end
@@ -59,8 +59,8 @@ module Briar
         timeout = opts[:timeout]
         msg = "waited for '#{timeout}' seconds but did not see '#{mark}' in navigation bar"
         wait_for(:timeout => timeout,
-                 :retry_frequency => BRIAR_RETRY_FREQ,
-                 :post_timeout => BRIAR_POST_TIMEOUT,
+                 :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+                 :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                  :timeout_message => msg) do
           queries.any? { |query| element_exists query }
         end
@@ -80,8 +80,8 @@ module Briar
         timeout = 1.0
         msg = "waited for '#{timeout}' seconds but i still see '#{name}' in navigation bar"
         wait_for(:timeout => timeout,
-                 :retry_frequency => BRIAR_RETRY_FREQ,
-                 :post_timeout => BRIAR_POST_TIMEOUT,
+                 :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+                 :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                  :timeout_message => msg) do
           element_does_not_exist qstr
         end
@@ -104,8 +104,8 @@ module Briar
     def go_back_after_waiting
       sleep(0.2)
       wait_for(:timeout => 1.0,
-               :retry_frequency => BRIAR_RETRY_FREQ,
-               :post_timeout => BRIAR_POST_TIMEOUT) do
+               :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+               :post_timeout => BRIAR_WAIT_STEP_PAUSE) do
         not query('navigationItemButtonView first').empty?
       end
       touch('navigationItemButtonView first')
@@ -115,7 +115,7 @@ module Briar
     def go_back_and_wait_for_view (view)
       sleep(0.2)
       wait_for(:timeout => BRIAR_WAIT_TIMEOUT,
-               :retry_frequency => BRIAR_RETRY_FREQ) do
+               :retry_frequency => BRIAR_WAIT_RETRY_FREQ) do
         not query('navigationItemButtonView first').empty?
       end
 
@@ -128,7 +128,7 @@ module Briar
 
     def touch_navbar_item(item_name, wait_for_view_id=nil)
       wait_for(:timeout => BRIAR_WAIT_TIMEOUT,
-               :retry_frequency => BRIAR_RETRY_FREQ) do
+               :retry_frequency => BRIAR_WAIT_RETRY_FREQ) do
         (index_of_navbar_button(item_name) != nil) || button_exists?(item_name)
       end
       sleep(0.2)
@@ -162,8 +162,8 @@ module Briar
     def should_see_navbar_with_title(title, timeout=BRIAR_WAIT_TIMEOUT)
       msg = "waited for '#{timeout}' seconds but i did not see #{title} in navbar"
       wait_for(:timeout => timeout,
-               :retry_frequency => BRIAR_RETRY_FREQ,
-               :post_timeout => BRIAR_POST_TIMEOUT,
+               :retry_frequency => BRIAR_WAIT_RETRY_FREQ,
+               :post_timeout => BRIAR_WAIT_STEP_PAUSE,
                :timeout_message => msg) do
         navbar_has_title? title
       end