web_console 0.5.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4060d9a69e1e767e102bc7a051351120aa85cab8
+  data.tar.gz: 1092a72ae0cad3c8dc18128c70e66b51db675baa
+SHA512:
+  metadata.gz: 81a88ed3dc9ce5ed53595cadcc73a28f6898380e7f1f73f319e251ffa31815a165d13f511ff8a4c4cdf2faff406fc3da11fe0740dba996bb42b98ea8ddfdadcd
+  data.tar.gz: 3f31ee8802fcb53a5ecde8239aea88c63702e8aaf21a8fb34c9e6fad92cddfd6f6d35990ec2f6fae146f0319e1fceb84b000a062a04a33f51a6036682c8d6cb5

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -0,0 +1,155 @@
+# encoding: utf-8
+# ruby_console Rakefile
+require 'rubygems'
+require 'rake'
+require 'date'
+require 'posix/spawn'
+
+# Defines gem name.
+def repo_name; 'web_console'; end # ruby_console published as web_console
+def gh_name; 'web_console'; end # the name as used on github.com
+def version_file; "lib/#{repo_name}/version.rb"; end
+def version_rgx; /VERSION = '([^']+)'/m; end
+
+def version
+  @version = @version || File.read(version_file).match(version_rgx)[1]
+end
+
+def bump
+  data = File.read version_file
+
+  v_line = data.match version_rgx
+  d_line = data.match /DATE = '([^']+)'/m
+
+  old_v = v_line[0]
+  old_d = d_line[0]
+
+  old_num = v_line[1]
+  new_num = old_num.split('.')
+  new_num[-1] = new_num[-1].to_i + 1
+  new_num = new_num.join '.'
+
+  new_v = old_v.sub old_num, new_num
+  puts "#{old_num} -> #{new_num}"
+
+  old_date = d_line[1]
+  new_date = Date.today.to_s
+  new_d = old_d.sub old_date, new_date
+  puts "#{old_date} -> #{new_date}" unless old_date == new_date
+
+  data.sub! old_v, new_v
+  data.sub! old_d, new_d
+
+  File.write version_file, data
+end
+
+desc 'Bump the version number and update the date.'
+task :bump do
+  bump
+end
+
+def tag_exists tag_name
+  cmd = %Q(git branch -a --contains "#{tag_name}")
+  POSIX::Spawn::Child.new(cmd).out.include? '* master'
+end
+
+# Inspired by Gollum's Rakefile
+desc 'Build and release a new gem to rubygems.org'
+task :release => :gem do
+  unless `git branch`.include? '* master'
+    puts 'Master branch required to release.'
+    exit!
+  end
+
+  # Commit then pull before pushing.
+  tag_name = "v#{version}"
+  raise 'Tag already exists!' if tag_exists tag_name
+
+  # Commit then pull before pushing.
+  sh "git commit --allow-empty -am 'Release #{version}'"
+  sh 'git pull'
+  sh "git tag #{tag_name}"
+  # update notes now that there's a new tag
+  Rake::Task['notes'].execute
+  sh "git commit --allow-empty -am 'Update release notes'"
+  sh 'git push origin master'
+  sh "git push origin #{tag_name}"
+  sh "gem push #{repo_name}-#{version}.gem"
+end
+
+desc 'Build and release a new gem to rubygems.org (same as release)'
+task :publish => :release do
+end
+
+desc 'Build a new gem'
+task :gem do
+  `chmod 0600 ~/.gem/credentials`
+  sh "gem build #{repo_name}.gemspec"
+end
+
+desc 'Build a new gem (same as gem task)'
+task :build => :gem do
+end
+
+desc 'Uninstall gem'
+task :uninstall do
+  cmd = "gem uninstall -aIx #{repo_name}"
+  # rescue on gem not installed error.
+  begin; sh "#{cmd}"; rescue; end
+end
+
+desc 'Install gem'
+task :install => [ :gem, :uninstall ] do
+  sh "gem install --no-rdoc --no-ri --local #{repo_name}-#{version}.gem"
+end
+
+desc 'Update release notes'
+task :notes do
+  tag_sort = ->(tag1,tag2) do
+    tag1_numbers = tag1.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
+    tag2_numbers = tag2.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
+    tag1_numbers <=> tag2_numbers
+  end
+
+  tags = `git tag`.split "\n"
+  tags.sort! &tag_sort
+  pairs = []
+  tags.each_index { |a| pairs.push tags[a] + '...' + tags[a+1] unless tags[a+1].nil? }
+
+  notes = ''
+
+  dates = `git log --tags --simplify-by-decoration --pretty="format:%d %ad" --date=short`.split "\n"
+
+  pairs.sort! &tag_sort
+  pairs.reverse! # pairs are in reverse order.
+
+  tag_date = []
+  pairs.each do |pair|
+    tag = pair.split('...').last
+    dates.each do |line|
+      # regular tag, or tag on master.
+      if line.include?(tag + ')') || line.include?(tag + ',')
+        tag_date.push tag + ' ' + line.match(/\d{4}-\d{2}-\d{2}/)[0]
+        break
+      end
+    end
+  end
+
+  pairs.each_index do |a|
+    data =`git log --pretty=oneline #{pairs[a]}`
+    new_data = ''
+    data.split("\n").each do |line|
+      hex = line.match(/[a-zA-Z0-9]+/)[0]
+      # use first 7 chars to match GitHub
+      comment = line.gsub(hex, '').strip
+      next if comment == 'Update release notes'
+      new_data += "- [#{hex[0...7]}](https://github.com/appium/#{gh_name}/commit/#{hex}) #{comment}\n"
+    end
+    data = new_data + "\n"
+
+    # last pair is the released version.
+    notes += "#### #{tag_date[a]}\n\n" + data + "\n"
+  end
+
+  File.open('release_notes.md', 'w') { |f| f.write notes.to_s.strip }
+end

data/bin/rubyweb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# appium ruby console = arc
+require 'rubygems'
+
+def print_version
+  require 'appium_console/version'
+  require 'appium_lib/common/version'
+  puts "web_console: v#{::Appium::Console::VERSION}"
+  puts "    appium_lib: v#{::Appium::VERSION}"
+end
+
+ARGV.each_index do |idx|
+  a = ARGV[idx]
+  b = ARGV[idx + 1]
+  if a.match /-?-?v/i
+    print_version
+    exit
+  elsif a.match /upgrade/i
+    cmd = [ 'gem uninstall -aIx appium_lib',
+      'gem uninstall -aIx web_console',
+      'gem install --no-rdoc --no-ri web_console'
+     ].join '; '
+    puts cmd
+    begin; `#{cmd}`; rescue; end
+    puts 'Upgrade complete.'
+    # exit after upgrading
+    exit
+  elsif a.match /setup/i
+    toml = File.join Dir.pwd, 'appium.txt'
+    if !b
+      puts 'setup called without android or ios. exiting.'
+      exit
+    end
+    File.open toml, 'w' do |f|
+      if b && b.match(/android/i)
+        f.puts %Q(APP_PATH="#{ENV['APP_PATH'] || '/path/to/my.apk'}")
+        f.puts %Q(APP_PACKAGE="#{ENV['APP_PACKAGE'] || 'com.my.Pkg'}")
+        f.puts %Q(APP_ACTIVITY="#{ENV['APP_ACTIVITY'] || 'StartActivity'}")
+        f.puts %Q(APP_WAIT_ACTIVITY="#{ENV['APP_WAIT_ACTIVITY'] || 'SplashActivity'}")
+      elsif b && b.match(/ios/i)
+        # iOS requires only APP_PATH
+        ios = ENV['APP_PATH']
+        ios = false if File.extname(ios).downcase == '.apk'
+        f.puts %Q(APP_PATH="#{ios || '/path/to/myiOS.app'}")
+      end
+    end
+    exit
+  end
+end
+
+require_relative '../lib/web_console'

data/ios_v_android.md

@@ -0,0 +1,58 @@
+#### Notes on iOS and Android Appium compatibility
+
+#### iOS Ghosting
+
+It's not uncommon to have multiple elements from different pages. To find the correct back button for example,
+it's necessary to find all the back buttons `names('Back')` and then return the first one that's displayed.
+
+This has implications for searching by index. If you select textfield 1 for the 1st textfield, then you may
+be getting a textfield from a previous page. The solution is to ensure each element has a unique accessibility identifier
+and to verify visibility and type.
+
+#### iPhone vs iPad
+
+iPad will contain elements from visible background screens. iPhone will have only one screen, however the keyboard can only be dismissed by clicking somewhere.
+The iPad has a hide keyboard button. The iPhone will use `Next` and `Go` on a typical login screen via the on screen keyboard.
+
+- setValue will immediately set the value
+- hideKeyboard will attempt to hide the iPad keyboard and fail on iPhone
+- find_element(:tag_name, :window).click should work everywhere
+
+##### Tag Names
+
+`secure` is not possible to implement on Android using uiautomator. `textfield` and `secure` are both considered `edittext`.
+
+`textfield` returns all textfields, including secure on Android. `secure` will error on Android.
+on iOS `textfield` will not match secure text fields.
+
+##### Search strategy
+
+Android
+
+- `android:id` is not accessible via uiautomator
+- `name` content description (defined in activity XML or dynamically)
+- `text` text content of the UI widget
+- `tag_name` the android class
+
+`text` is [not a selenium search strategy](https://github.com/appium/appium/issues/241#issuecomment-14582659) so use XPath.
+
+`secure` on iOS will return value.
+
+`EditText` used as password field on Andorid will always return an empty string.
+
+--
+
+iOS .name returns the [accessibility attribute](http://developer.apple.com/library/ios/#documentation/ToolsLanguages/Reference/UIAElementClassReference/UIAElement/UIAElement.html#//apple_ref/javascript/instm/UIAElement/name) if it's set. if not set, the string value is used.
+
+Android .name returns the accessibility attribute and nothing if it's not set.
+
+#### More options button
+
+The android `options` button will be hidden if the device has a hardware menu button. To work around this:
+
+```ruby
+# see abs__action_menu_overflow_description in ActionBarSherlock
+# click more options if it exists. if it doesn't then the device has a hardware menu button that must be pressed instead.
+exists { name 'more options' } ? name('more options').click : mobile(:keyevent, keycode: 82)
+```
+