calabash 1.2.1 → 1.9.9.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ee016ed68b6bfe5aceb636f863346c03eebffb6
-  data.tar.gz: dd7e895f088e3a4385f2e36cfb7091a05834bb25
+  metadata.gz: 994996bafe7d310ab1068d4784c48fce9541c1c7
+  data.tar.gz: 7d3918c947af930be40caea37dee45320d76a817
 SHA512:
-  metadata.gz: 4ae9113569f311a1d4116f284f8479a771bda25d67bc5347e02248f096e54dc3c05ad793cc8944a0eefd04167eba3afd6a8c9463f2885292c198d63c4e8e7d8e
-  data.tar.gz: 878e7d5b81921fdbd8200dcecd104230ae7979880e4231ab3033c21f10f9e47937a68fbe72813f4bad9a12b8991fe68323f7d60c3aa6bc6f291eab2f9771d6e3
+  metadata.gz: 0041eda36898e5eca293981ff2fd6c6ee3ad609b9a1a55efe5b552c3e74857de1b8101acf7a6fedd3777d150f533c15b99782686ee042f63877250132c5b7dde
+  data.tar.gz: db96e189f2cf24bc6543f85cd3e52856d09edf10ec3c1be8e5181df63dc9a2251e695bdaa58bc992c6897e565756a4b71d7092dc6ac91653a9e3833eeca007f5

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+## Contributing
+
+***All pull requests should be based off the `develop` branch.***
+
+The Calabash Toolchain uses git-flow.
+
+See these links for information about git-flow and git best practices.
+
+##### Git Flow Step-by-Step guide
+
+* https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
+
+##### Git Best Practices
+
+* http://justinhileman.info/article/changing-history/
+
+##### git-flow command line tool
+
+We don't use the git-flow tools, but this is useful anyway.
+
+* http://danielkummer.github.io/git-flow-cheatsheet/
+
+## Start a Feature
+
+Start your work on a feature branch based off develop.
+
+```
+# If you don't already have the develop branch
+$ git fetch origin
+$ git co -t origin/develop
+
+# If you already have the develop branch
+$ git co develop
+$ git pull origin develop
+$ git co -b feature/my-new-feature
+
+# Publish your branch and make a pull-request on `develop`
+$ git push -u origin feature/my-new-feature
+```

data/LICENSE

@@ -1,21 +1,204 @@
-calabash
-
-Copyright (c) 2013 Xamarin (http://www.xamarin.com). All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Eclipse Public License - v 1.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
+LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
+CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and documentation
+   distributed under this Agreement, and
+b) in the case of each subsequent Contributor:
+    i) changes to the Program, and
+   ii) additions to the Program;
+
+   where such changes and/or additions to the Program originate from and are
+   distributed by that particular Contributor. A Contribution 'originates'
+   from a Contributor if it was added to the Program by such Contributor
+   itself or anyone acting on such Contributor's behalf. Contributions do not
+   include additions to the Program which: (i) are separate modules of
+   software distributed in conjunction with the Program under their own
+   license agreement, and (ii) are not derivative works of the Program.
+
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor which are
+necessarily infringed by the use or sale of its Contribution alone or when
+combined with the Program.
+
+"Program" means the Contributions distributed in accordance with this
+Agreement.
+
+"Recipient" means anyone who receives the Program under this Agreement,
+including all Contributors.
+
+2. GRANT OF RIGHTS
+  a) Subject to the terms of this Agreement, each Contributor hereby grants
+     Recipient a non-exclusive, worldwide, royalty-free copyright license to
+     reproduce, prepare derivative works of, publicly display, publicly
+     perform, distribute and sublicense the Contribution of such Contributor,
+     if any, and such derivative works, in source code and object code form.
+  b) Subject to the terms of this Agreement, each Contributor hereby grants
+     Recipient a non-exclusive, worldwide, royalty-free patent license under
+     Licensed Patents to make, use, sell, offer to sell, import and otherwise
+     transfer the Contribution of such Contributor, if any, in source code and
+     object code form. This patent license shall apply to the combination of
+     the Contribution and the Program if, at the time the Contribution is
+     added by the Contributor, such addition of the Contribution causes such
+     combination to be covered by the Licensed Patents. The patent license
+     shall not apply to any other combinations which include the Contribution.
+     No hardware per se is licensed hereunder.
+  c) Recipient understands that although each Contributor grants the licenses
+     to its Contributions set forth herein, no assurances are provided by any
+     Contributor that the Program does not infringe the patent or other
+     intellectual property rights of any other entity. Each Contributor
+     disclaims any liability to Recipient for claims brought by any other
+     entity based on infringement of intellectual property rights or
+     otherwise. As a condition to exercising the rights and licenses granted
+     hereunder, each Recipient hereby assumes sole responsibility to secure
+     any other intellectual property rights needed, if any. For example, if a
+     third party patent license is required to allow Recipient to distribute
+     the Program, it is Recipient's responsibility to acquire that license
+     before distributing the Program.
+  d) Each Contributor represents that to its knowledge it has sufficient
+     copyright rights in its Contribution, if any, to grant the copyright
+     license set forth in this Agreement.
+
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code form under
+its own license agreement, provided that:
+
+  a) it complies with the terms and conditions of this Agreement; and
+  b) its license agreement:
+      i) effectively disclaims on behalf of all Contributors all warranties
+         and conditions, express and implied, including warranties or
+         conditions of title and non-infringement, and implied warranties or
+         conditions of merchantability and fitness for a particular purpose;
+     ii) effectively excludes on behalf of all Contributors all liability for
+         damages, including direct, indirect, special, incidental and
+         consequential damages, such as lost profits;
+    iii) states that any provisions which differ from this Agreement are
+         offered by that Contributor alone and not by any other party; and
+     iv) states that source code for the Program is available from such
+         Contributor, and informs licensees how to obtain it in a reasonable
+         manner on or through a medium customarily used for software exchange.
+
+When the Program is made available in source code form:
+
+  a) it must be made available under this Agreement; and
+  b) a copy of this Agreement must be included with each copy of the Program.
+     Contributors may not remove or alter any copyright notices contained
+     within the Program.
+
+Each Contributor must identify itself as the originator of its Contribution,
+if
+any, in a manner that reasonably allows subsequent Recipients to identify the
+originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities with
+respect to end users, business partners and the like. While this license is
+intended to facilitate the commercial use of the Program, the Contributor who
+includes the Program in a commercial product offering should do so in a manner
+which does not create potential liability for other Contributors. Therefore,
+if a Contributor includes the Program in a commercial product offering, such
+Contributor ("Commercial Contributor") hereby agrees to defend and indemnify
+every other Contributor ("Indemnified Contributor") against any losses,
+damages and costs (collectively "Losses") arising from claims, lawsuits and
+other legal actions brought by a third party against the Indemnified
+Contributor to the extent caused by the acts or omissions of such Commercial
+Contributor in connection with its distribution of the Program in a commercial
+product offering. The obligations in this section do not apply to any claims
+or Losses relating to any actual or alleged intellectual property
+infringement. In order to qualify, an Indemnified Contributor must:
+a) promptly notify the Commercial Contributor in writing of such claim, and
+b) allow the Commercial Contributor to control, and cooperate with the
+Commercial Contributor in, the defense and any related settlement
+negotiations. The Indemnified Contributor may participate in any such claim at
+its own expense.
+
+For example, a Contributor might include the Program in a commercial product
+offering, Product X. That Contributor is then a Commercial Contributor. If
+that Commercial Contributor then makes performance claims, or offers
+warranties related to Product X, those performance claims and warranties are
+such Commercial Contributor's responsibility alone. Under this section, the
+Commercial Contributor would have to defend claims against the other
+Contributors related to those performance claims and warranties, and if a
+court requires any other Contributor to pay any damages as a result, the
+Commercial Contributor must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED 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. Each
+Recipient is solely responsible for determining the appropriateness of using
+and distributing the Program and assumes all risks associated with its
+exercise of rights under this Agreement , including but not limited to the
+risks and costs of program errors, compliance with applicable laws, damage to
+or loss of data, programs or equipment, and unavailability or interruption of
+operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
+CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
+LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of the
+remainder of the terms of this Agreement, and without further action by the
+parties hereto, such provision shall be reformed to the minimum extent
+necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Program itself
+(excluding combinations of the Program with other software or hardware)
+infringes such Recipient's patent(s), then such Recipient's rights granted
+under Section 2(b) shall terminate as of the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it fails to
+comply with any of the material terms or conditions of this Agreement and does
+not cure such failure in a reasonable period of time after becoming aware of
+such noncompliance. If all Recipient's rights under this Agreement terminate,
+Recipient agrees to cease use and distribution of the Program as soon as
+reasonably practicable. However, Recipient's obligations under this Agreement
+and any licenses granted by Recipient relating to the Program shall continue
+and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement, but in
+order to avoid inconsistency the Agreement is copyrighted and may only be
+modified in the following manner. The Agreement Steward reserves the right to
+publish new versions (including revisions) of this Agreement from time to
+time. No one other than the Agreement Steward has the right to modify this
+Agreement. The Eclipse Foundation is the initial Agreement Steward. The
+Eclipse Foundation may assign the responsibility to serve as the Agreement
+Steward to a suitable separate entity. Each new version of the Agreement will
+be given a distinguishing version number. The Program (including
+Contributions) may always be distributed subject to the version of the
+Agreement under which it was received. In addition, after a new version of the
+Agreement is published, Contributor may elect to distribute the Program
+(including its Contributions) under the new version. Except as expressly
+stated in Sections 2(a) and 2(b) above, Recipient receives no rights or
+licenses to the intellectual property of any Contributor under this Agreement,
+whether expressly, by implication, estoppel or otherwise. All rights in the
+Program not expressly granted under this Agreement are reserved.
+
+This Agreement is governed by the laws of the State of New York and the
+intellectual property laws of the United States of America. No party to this
+Agreement will bring a legal action under this Agreement more than one year
+after the cause of action arose. Each party waives its rights to a jury trial in
+any resulting litigation.
+

data/README.md

@@ -1,7 +1,37 @@
-What?
-=====
-Wrapper gem for Calabash iOS, Android and Xamarin Test Cloud
+| master  | develop | [versioning](VERSIONING.md) | [license](LICENSE) | [contributing](CONTRIBUTING.md)|
+|---------|---------|-----------------------------|--------------------|--------------------------------|
+|[![Build Status](https://travis-ci.org/calabash/calabash.svg?branch=master)](https://travis-ci.org/calabash/calabash)| [![Build Status](https://travis-ci.org/calabash/calabash.svg?branch=develop)](https://travis-ci.org/calabash/calabash)| [![GitHub version](https://badge.fury.io/gh/calabash%2Fcalabash.svg)](http://badge.fury.io/gh/calabash%2Fcalabash) |[![License](https://img.shields.io/badge/licence-Eclipse-blue.svg)](http://opensource.org/licenses/EPL-1.0) | [![Contributing](https://img.shields.io/badge/contrib-gitflow-orange.svg)](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow/)|
 
-License
-=======
-calabash the wrapper gem is available under the MIT license. See the LICENSE file for more info.
+## Calabash
+
+Automated Acceptance Testing for Mobile Apps
+
+## Initial workflow
+
+**TL;DR**
+
+```
+$ cd calabash
+$ ./copy_repos.sh
+$ ./changing_old_files.sh
+```
+
+Before Calabash is ready to be released, the old gems will exist outside version control. To make a change run the script `copy_repos.sh`. This will copy the Android and iOS repositories and extract them as files in the directory `old`. Then execute `changing_old_files.sh`. This script will move old files into their new directories. To make changes to "old files" e.g. move them, add your steps to `changing_old_files.sh` and execute it. To make code changes to old files, change them locally first to ensure they work. Then copy the change to the branch `united` on either iOS or Android. Commit the changes and push them upstream. `copy_repos.sh` will always download the newest files.
+
+## Testing
+
+### rspec
+
+```
+$ be rake unit # All unit tests.
+$ be rake spec # All tests.  Launches iOS Simulators, etc.
+$ be guard     # Run unit tests as you develop.
+```
+
+### cucumber
+
+```
+$ cd cucumber/ios
+$ bundle update
+$ be cucumber
+```

data/VERSIONING.md

@@ -0,0 +1,16 @@
+## Versioning
+
+Calabash tries very hard to comply with Semantic Versioning [1] rules.
+
+However, the semantic versioning spec is incompatible with RubyGem's patterns for pre-release gems.
+  
+> "But returning to the practical: No release version of SemVer is compatible with Rubygems." - _David Kellum_ [2]
+
+Calabash version numbers will be in this form:
+
+```
+<major>.<minor>.<patch>[.pre<N>]
+```
+
+- [1] http://semver.org/
+- [2] http://gravitext.com/2012/07/22/versioning.html

data/bin/calabash

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+require 'calabash'
+
+module Calabash
+  module CLI
+    require 'calabash/cli'
+
+    class CLI
+      include Calabash::CLI::Helpers
+      include Calabash::CLI::Build
+      include Calabash::CLI::Console
+      include Calabash::CLI::Generate
+      include Calabash::CLI::Resign
+      include Calabash::CLI::Run
+      include Calabash::CLI::SetupKeystore
+
+      def initialize(arguments)
+        @arguments = arguments.dup
+        @original_arguments = @arguments.dup
+        @options = {verbose: false}
+        @platform = nil
+      end
+
+      def evaluate
+        parse_arguments!
+      end
+
+      def set_platform!(platform)
+        if @platform.nil?
+          case platform
+            when :android
+              require 'calabash/android'
+            when :ios
+              require 'calabash/ios'
+            else
+              raise "Invalid platform '#{platform}'"
+          end
+
+          @platform = platform
+        elsif @platform != platform
+          raise "Cannot change platform from '#{@platform}' to '#{platform}'"
+        end
+      end
+
+      private
+
+      def parse_arguments!
+        argument = @arguments.shift
+
+        case argument
+          when '-v', '--verbose'
+            @options[:verbose] = true
+            Logger.log_levels += [:debug]
+            parse_arguments!
+          when '--platform'
+            platform = @arguments.shift.downcase
+
+            fail("Invalid specified platform '#{platform}'") unless platform == 'android' || platform == 'ios'
+
+            set_platform!(platform.to_sym)
+
+            parse_arguments!
+          when 'version'
+            puts Calabash::VERSION
+          when 'build'
+            parse_build_arguments!
+          when 'resign'
+            parse_resign_arguments!
+          when 'console'
+            parse_console_arguments!
+          when 'gen'
+            parse_generate_arguments!
+          when 'run'
+            parse_run_arguments!
+          when 'setup-keystore'
+            parse_setup_keystore_arguments!
+          when 'help'
+            argument = @arguments.shift
+
+            if argument.nil?
+              print_usage
+            else
+              print_usage_for(key_for_command(argument))
+            end
+          when nil
+            print_usage
+          else
+            fail("Invalid argument #{argument}.\n  For help use 'calabash help'")
+        end
+      end
+    end
+  end
+end
+
+Calabash::CLI::CLI.new(ARGV).evaluate

data/lib/calabash.rb

@@ -1 +1,185 @@
-require 'calabash/version'
+# Calabash is a Behavior-driven development (BDD) framework for Android and
+# iOS. It supports both native and hybrid app testing.
+#
+# It is developed and maintained by Xamarin and is released under the Eclipse
+# Public License.
+module Calabash
+  require 'calabash/patch/run_loop'
+  require 'calabash/version'
+  require 'calabash/environment'
+  require 'calabash/logger'
+  require 'calabash/color'
+  require 'calabash/utility'
+  require 'calabash/application'
+  require 'calabash/device'
+  require 'calabash/http'
+  require 'calabash/server'
+  require 'calabash/wait'
+  require 'calabash/query'
+  require 'calabash/query_result'
+  require 'calabash/screenshot'
+  require 'calabash/gestures'
+  require 'calabash/life_cycle'
+  require 'calabash/location'
+  require 'calabash/orientation'
+  require 'calabash/query'
+  require 'calabash/text'
+  require 'calabash/interactions'
+  require 'calabash/defaults'
+  require 'calabash/console_helpers'
+
+
+  require 'calabash/patch'
+  Calabash::Patch.apply_patches!
+
+
+  include Utility
+  include Calabash::Wait
+  include Calabash::Screenshot
+  include Calabash::Gestures
+  include Calabash::LifeCycle
+  include Calabash::Location
+  include Calabash::Orientation
+  include Calabash::Text
+  include Calabash::Interactions
+  extend Calabash::Defaults
+
+  require 'calabash/page'
+
+  # Instantiate a page object.
+  #
+  # @example
+  #  # android/pages/login_page.rb
+  #  class Android::LoginPage < Calabash::Page
+  #    include Calabash::Android
+  #
+  #    [...]
+  #  end
+  #
+  #  # step definition
+  #  Given([...]) do
+  #    # Calabash will determine your platform and pick the Android page.
+  #    page(LoginPage).method
+  #  end
+  #
+  # @param [Class] The page to instantiate
+  # @return [Calabash::Page] An instance of the page class
+  def page(page_class)
+    platform_module = if Device.default.is_a?(Android::Device)
+                        Object.const_get(:Android)
+                      elsif Device.default.is_a?(IOS::Device)
+                        Object.const_get(:IOS)
+                      else
+                        raise 'Cannot detect running platform'
+                      end
+
+    unless page_class.is_a?(Class)
+      raise ArgumentError, "Expected a 'Class', got '#{page_class.class}'"
+    end
+
+    page_name = page_class.name.split('::').last
+
+    if platform_module.const_defined?(page_name, false)
+      page_class = platform_module.const_get(page_name, false)
+
+      if page_class.is_a?(Class)
+        page = page_class.send(:new, self)
+
+        if page.is_a?(Calabash::Page)
+          page
+        else
+          raise "Page '#{page_class}' is not a Calabash::Page"
+        end
+      else
+        raise "Page '#{page_class}' is not a class"
+      end
+    else
+      raise "No such page defined '#{platform_module}::#{page_name}'"
+    end
+  end
+
+  def self.new_embed_method!(method)
+    EmbeddingContext.new_embed_method(method)
+  end
+
+  # @!visibility private
+  def self.add_embed_method(base, method)
+    # These methods will be invoked **before** the base module is mutated.
+    # This means that no methods defined in the base module stem from Calabash
+    # yet.
+    unless base.respond_to?(:embed)
+      # The 'embed' method was not defined in the including base module. We
+      # don't want to define embed as Calabash's own method, as Calabash should
+      # not be globally mutated because of this include/extend. Notice that the
+      # embedding context might be mutated. e.g. when Calabash detects it is
+      # running in the context of Cucumber. Ruby acknowledges this change in
+      # all modules that include/extend the EmbeddingContext module.
+      base.send(method, EmbeddingContext)
+    end
+  end
+
+  # @!visibility private
+  def self.included(base)
+    if base.to_s == 'Calabash::Android' || base.to_s == 'Calabash::IOS'
+      return
+    end
+
+    add_embed_method(base, :include)
+  end
+
+  # @!visibility private
+  def self.extended(base)
+    # We would like to use Cucumber's embed method if possible.
+    # This is a hook to obtain this method
+    if base.singleton_class.included_modules.map(&:to_s).include?('Cucumber::RbSupport::RbWorld')
+      on_cucumber_context(base)
+    else
+      add_embed_method(base, :extend)
+    end
+  end
+
+  private
+
+  # @!visibility private
+  def self.on_new_context(base)
+    cucumber_embed = base.method(:embed)
+
+    unless EmbeddingContext.embedding_context_set?
+      new_embed_method!(cucumber_embed)
+    end
+  end
+
+  # @!visibility private
+  def self.on_cucumber_context(base)
+    on_new_context(base)
+  end
+
+  # @!visibility private
+  module EmbeddingContext
+    @@has_set_embedding_context ||= false
+
+    def self.embedding_context_set?
+      @@has_set_embedding_context
+    end
+
+    def self.new_embed_method(method)
+      define_method(:embed) do |*args|
+        method.call(*args)
+      end
+
+      @@has_set_embedding_context = true
+    end
+
+    def embed(*_)
+      Logger.warn 'Embed is not available in this context. Will not embed.'
+    end
+  end
+end
+
+unless Object.const_defined?(:Android)
+  Object.const_set(:Android, Module.new)
+end
+
+unless Object.const_defined?(:IOS)
+  Object.const_set(:IOS, Module.new)
+end