appom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19d5e9be64b9d999fbae65e039edf9bcaf536d4ddab5b038d75794a4a5f1026a
+  data.tar.gz: b0b1008c8e03da65545f6186b054a3f571243f94c1d41b226fb60b3f517e99af
+SHA512:
+  metadata.gz: dd95475d8526f2d9342e19d9abbbedb3e590904c5d02877b3c97aa9413ee28be7917cad67641db82146d83c4d918cc224e3a2237f99a0ecea5b3064c029bbd1d
+  data.tar.gz: b19155129ddc7b46408af1494089c1dad03d85dbade07f98ba38637e175fb591a163f56b12a7d77a64e8334bda7a2846c097436344998bdce8abd6db1003a203

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Harry.Tran
+
+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.

data/README.md

@@ -0,0 +1,70 @@
+# Appom
+[![Gem Version](https://badge.fury.io/rb/appom.svg)](http://badge.fury.io/rb/appom)
+
+A Page Object Model for Appium
+
+Appom gives you a simple, clean and semantic for describing your application. Appom implements the Page Object Model pattern on top of Appium.
+
+## Idea
+If you have used the [Page Object Model](https://medium.com/tech-tajawal/page-object-model-pom-design-pattern-f9588630800b) (POM) with Appium you will probably know about [Capybara](https://github.com/teamcapybara/capybara) and [SitePrism](https://github.com/natritmeyer/site_prism). But CapyBara and SitePrism are designed for the web rather than the mobile.
+
+Using POM with SitePrism and CapyBara makes interacting with Appium really not that direct. And Appium is not confirmed to work well with these two libraries.
+
+Wishing to use the Page Object Model in the simplest way we created Appom. The idea created for Appom is taken from CapyBara and SitePrism.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'appom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install appom
+
+## Usage
+
+Here's an overview of how Appom is designed to be used:
+
+### Register Appium Driver
+Appium use appium directly to find elements. So that to use Appom you must register Appium Driver for Appom
+```ruby
+Appom.register_driver do
+  options = {
+    appium_lib: appium_lib_options,
+    caps: caps
+  }
+  Appium::Driver.new(options, false)
+end
+```
+`appium_lib_options` and `caps` are options to initiate a appium driver. You can follow [Appium Ruby Client](https://github.com/appium/ruby_lib)
+
+
+### Define a page
+```ruby
+class LoginPage < Appom::Page
+  element :email, :accessibility_id, 'email_text_field'
+  element :password, :accessibility_id, 'password_text_field'
+  element :sign_in_button, :accessibility_id, 'sign_in_button'
+end
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [Appom](https://github.com/hoangtaiki/appom). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Appom project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hoangtaiki/appom/blob/master/CODE_OF_CONDUCT.md).

data/lib/appom.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'appom/version'
+require 'appium_lib'
+require 'appom/cucumber'
+
+module Appom
+  # A item was defined without a selector
+  class InvalidElementError < StandardError; end
+  # A block was passed to the method, which it cannot interpret
+  class UnsupportedBlockError < StandardError; end
+
+  autoload :ElementContainer, 'appom/element_container'
+  autoload :Page, 'appom/page'
+
+  class << self
+    attr_accessor :driver
+
+    # Register a new appium driver for Appom.
+    # @return [Appium::Driver] A appium driver instance
+    def register_driver(&block)
+      @driver = block.call()
+      setup_exit_handler
+    end
+
+    # Creates a new global driver and quits the old one if it exists.
+    def start_driver
+      @driver.start_driver
+    end
+
+    # Reset the device, relaunching the application.
+    def reset_driver
+      @driver.reset
+    end
+
+    # After run all scenario and exit we will quit driver to close appliction under test
+    def setup_exit_handler
+      main = Process.pid
+      at_exit do
+        @driver.driver_quit if Process.pid == main
+      end
+    end
+  end
+end
+
+World(Appom)
+

data/lib/appom/cucumber.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# We will start driver before each scenario
+Before do
+  Appom.start_driver
+end

data/lib/appom/element_container.rb

@@ -0,0 +1,92 @@
+module Appom
+  module ElementContainer
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_reader :mapped_items
+
+      # Raise if contain a block
+      def raise_if_block(obj, name, has_block, type)
+        return unless has_block
+
+        puts "Type passed in: #{type}"
+        puts "#{obj.class}##{name} does not accept blocks"
+
+        raise Appom::UnsupportedBlockError
+      end
+
+      ##
+      #
+      # Declare an element with name and args to find it
+      #
+      #     element :email, :accessibility_id, 'email_text_field'
+      #
+      # @param name             Element name
+      # @param *find_args       An array contain information to find the element. It contains locator stratery and search target
+      # http://appium.io/docs/en/commands/element/find-element/
+      #
+      # Element doesn't support block so that will raise if pass a block when declare
+      #
+      def element(name, *find_args)
+        build(name, *find_args) do |*runtime_args, &block|
+          raise_if_block(self, name, !block.nil?, :element)
+          define_method(name) do
+            find(*find_args)
+          end
+        end
+      end
+
+      ##
+      #
+      # Declare an elements with name and args to find it
+      #
+      #     elements :contact_cell, :accessibility_id, 'contact_cell'
+      #
+      # @param name             Element name
+      # @param *find_args       An array contain information to find the elements. It contains locator stratery and search target
+      # http://appium.io/docs/en/commands/element/find-element/
+      #
+      # Elements doesn't support block so that will raise if pass a block when declare
+      #
+      def elements(name, *find_args)
+        build(name, *find_args) do |*runtime_args, &block|
+          define_method(name) do
+            raise_if_block(self, name, !block.nil?, :elements)
+            all(*find_args)
+          end
+        end
+      end
+
+      ##
+      # Add item to @mapped_items array
+      #
+      # @param item         Item need to add
+      #
+      def add_to_mapped_items(item)
+        @mapped_items ||= []
+        @mapped_items << item
+      end
+
+      private
+
+      # Add item to @mapped_items or define mothod to notify that we can't find item without args
+      def build(name, *find_args)
+        if find_args.empty?
+          create_error_method(name)
+        else
+          add_to_mapped_items(name)
+          yield
+        end
+      end
+
+      # Define mothod to notify that we can't find item without args
+      def create_error_method(name)
+        define_method(name) do
+          raise Appom::InvalidElementError
+        end
+      end
+    end
+  end
+end

data/lib/appom/page.rb

@@ -0,0 +1,16 @@
+module Appom
+  class Page
+    include Appium
+    include ElementContainer
+
+    # Find an element
+    def find(*find_args)
+      Appom.driver.find_element(*find_args)
+    end
+
+    # Find elements
+    def all(*find_args)
+      Appom.driver.find_elements(*find_args)
+    end
+  end
+end

data/lib/appom/version.rb

@@ -0,0 +1,3 @@
+module Appom
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: appom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry.Tran
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appium_lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.15.1
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+description: Appom gives you a simple, clean and semantic for describing your application.
+  Appom implements the Page Object Model pattern on top of Appium.
+email:
+- hoang@platphormcorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/appom.rb
+- lib/appom/cucumber.rb
+- lib/appom/element_container.rb
+- lib/appom/page.rb
+- lib/appom/version.rb
+homepage: https://github.com/hoangtaiki/appom
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A Page Object Model for Appium
+test_files: []