appom 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0949477113260f4e785a805fa8e65fba84220ba6a0ee596f28fa41b429e672cc
-  data.tar.gz: 3b0a17a7cdfca9377d16fb5db85a756e8fa9bab30de7fca678a60f349b421f0a
+  metadata.gz: 32300dd3f4ed1e4ff737e2614ab06ce5c976b4cab63701b83207ab56419c1ebf
+  data.tar.gz: de9ef291dee27ace03da53c601f29b7d0143cf71ad51dcf95e32ba5cf494f2be
 SHA512:
-  metadata.gz: 762d159a3d726469f66dcfe6334a4ccfc8174fe63602c6f238759c6295a8edbc305780804bb9811dba54407e77f9153c220c4d711303043667d4599480c4030a
-  data.tar.gz: baaaa66a0fb77ad1917451b5f54216bc7c1331c52f622f19c212f612fff1494480980a7eee07256eea152554edb6aec0c610bc4da73abf04014e131902619191
+  metadata.gz: e356e9bd0586b78bc5cd8dc47dbb11e3de9cdaf531db7fdc27e4a64fa25e03162be3e04ba0126be099162500cce4a1723617f880bcf26000a2d1216cf812a0f4
+  data.tar.gz: 37c7e1ad64adae8dbf3a0033bbfe0264d11c7d9ae35c4a2df0d1e535298c9c6868011db5f322e64090134a42958851f8f1dff9b2dea6aa56b032a3cd8fa3ce10

data/lib/appom.rb

@@ -18,6 +18,8 @@ module Appom
   autoload :ElementContainer, 'appom/element_container'
   autoload :Page, 'appom/page'
   autoload :Wait, 'appom/wait'
+  autoload :Section, 'appom/section'
+  autoload :ElementFinder, 'appom/element_finder'
 
   class << self
     attr_accessor :driver

data/lib/appom/element_container.rb

@@ -42,13 +42,13 @@ module Appom
       # Element doesn't support block so that will raise if pass a block when declare
       #
       def element(name, *find_args)
-        build_element(name, *find_args) do |*runtime_args, &block|
-          define_method(name) do
+        build_element(name, *find_args) do
+          define_method(name) do |*runtime_args, &block|
             raise_if_block(self, name, !block.nil?, :element)
-            find(*merge_args(find_args, runtime_args))
+            _find(*merge_args(find_args, runtime_args))
           end
           define_method("#{name}_params") do
-            merge_args(find_args, runtime_args)
+            merge_args(find_args)
           end
         end
       end
@@ -66,13 +66,41 @@ module Appom
       # Elements doesn't support block so that will raise if pass a block when declare
       #
       def elements(name, *find_args)
-        build_elements(name, *find_args) do |*runtime_args, &block|
-          define_method(name) do
+        build_elements(name, *find_args) do
+          define_method(name) do |*runtime_args, &block|
             raise_if_block(self, name, !block.nil?, :elements)
-            all(*merge_args(find_args, runtime_args))
+            _all(*merge_args(find_args, runtime_args))
           end
           define_method("#{name}_params") do
-            merge_args(find_args, runtime_args)
+            merge_args(find_args)
+          end
+        end
+      end
+
+      def section(name, *args, &block)
+        section_class, find_args = extract_section_options(args, &block)
+        build_element(name, *find_args) do
+          define_method(name) do |*runtime_args, &block|
+            section_element = _find(*merge_args(find_args, runtime_args))
+            section_class.new(self, section_element)
+          end
+          define_method("#{name}_params") do
+            merge_args(find_args)
+          end
+        end
+      end
+
+      def sections(name, *args, &block)
+        section_class, find_args = extract_section_options(args, &block)
+        build(name, *find_args) do
+          define_method(name) do |*runtime_args, &block|
+            raise_if_block(self, name, !block.nil?, :sections)
+            _all(*merge_args(find_args, runtime_args)).map do |element|
+              section_class.new(self, element)
+            end
+          end
+          define_method("#{name}_params") do
+            merge_args(find_args)
           end
         end
       end
@@ -207,6 +235,49 @@ module Appom
           end
         end
       end
+
+      ##
+      # Extract section options
+      # @return section class name and the remaining parameters
+      #
+      def extract_section_options(args, &block)
+        if args.first.is_a?(Class)
+          klass = args.shift
+          section_class = klass if klass.ancestors.include?(Appom::Section)
+        end
+
+        section_class = deduce_section_class(section_class, &block)
+        arguments = deduce_search_arguments(section_class, args)
+        [section_class, arguments]
+      end
+
+      ##
+      # Deduce section class
+      #
+      def deduce_section_class(base_class, &block)
+        klass = base_class
+
+        klass = Class.new(klass || Appom::Section, &block) if block_given?
+
+        unless klass
+          raise ArgumentError, 'You should provide descendant of Appom::Section class or/and a block as the second argument.'
+        end
+        klass
+      end
+
+      ##
+      # Deduce search parameters
+      #
+      def deduce_search_arguments(section_class, args)
+        extract_search_arguments(args) ||
+          extract_search_arguments(section_class.default_search_arguments) ||
+          raise(ArgumentError, 'You should provide search arguments in section creation or set_default_search_arguments within section class')
+      end
+
+      def extract_search_arguments(args)
+        args if args && !args.empty?
+      end
+
     end
   end
 end

data/lib/appom/element_finder.rb

@@ -0,0 +1,69 @@
+module Appom
+  module ElementFinder
+    # Find an element
+    def _find(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until { page.find_element(*find_args) }
+    end
+
+    # Find elements
+    def _all(*find_args)
+      page.find_elements(*find_args)
+    end
+
+    ##
+    # Use wait to check element non-exist
+    # Before timeout we will try to find elements and check response is empty
+    #
+    def wait_check_util_empty(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until do
+        page.find_elements(*find_args).empty?
+      end
+    end
+
+    ##
+    # Use wait to check element exist
+    # Before timeout we will try to find elements and check response is not empty
+    #
+    def wait_check_util_not_empty(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until do
+        !page.find_elements(*find_args).empty?
+      end
+    end
+
+    ##
+    # Use wait to get elements
+    # Before timeout we will try to find elements until response is not empty
+    #
+    def wait_util_get_not_empty(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until do
+        result = page.find_elements(*find_args)
+        # If reponse is empty we will return false to make it not pass Wait condition
+        if result.empty?
+          return false
+        end
+        # Return result
+        return result
+      end
+    end
+
+    ##
+    # Wait until an element will be enable
+    #
+    def wait_util_element_enabled(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until { page.find_element(*find_args).enabled? }
+    end
+
+    ##
+    # Wait until an element will be disable
+    #
+    def wait_util_element_disabled(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until { !page.find_element(*find_args).enabled? }
+    end
+  end
+end

data/lib/appom/page.rb

@@ -2,71 +2,10 @@ module Appom
   class Page
     include Appium
     include ElementContainer
+    include ElementFinder
 
-    # Find an element
-    def find(*find_args)
-      wait = Wait.new(timeout: Appom.max_wait_time)
-      wait.until { Appom.driver.find_element(*find_args) }
-    end
-
-    # Find elements
-    def all(*find_args)
-      Appom.driver.find_elements(*find_args)
-    end
-
-    ##
-    # Use wait to check element non-exist
-    # Before timeout we will try to find elements and check response is empty
-    #
-    def wait_check_util_empty(*find_args)
-      wait = Wait.new(timeout: Appom.max_wait_time)
-      wait.until do
-        Appom.driver.find_elements(*find_args).empty?
-      end
-    end
-
-    ##
-    # Use wait to check element exist
-    # Before timeout we will try to find elements and check response is not empty
-    #
-    def wait_check_util_not_empty(*find_args)
-      wait = Wait.new(timeout: Appom.max_wait_time)
-      wait.until do
-        !Appom.driver.find_elements(*find_args).empty?
-      end
-    end
-
-    ##
-    # Use wait to get elements
-    # Before timeout we will try to find elements until response is not empty
-    #
-    def wait_util_get_not_empty(*find_args)
-      wait = Wait.new(timeout: Appom.max_wait_time)
-      wait.until do
-        result = Appom.driver.find_elements(*find_args)
-        # If reponse is empty we will return false to make it not pass Wait condition
-        if result.empty?
-          return false
-        end
-        # Return result
-        return result
-      end
-    end
-
-    ##
-    # Wait until an element will be enable
-    #
-    def wait_util_element_enabled(*find_args)
-      wait = Wait.new(timeout: Appom.max_wait_time)
-      wait.until { Appom.driver.find_element(*find_args).enabled? }
-    end
-
-    ##
-    # Wait until an element will be disable
-    #
-    def wait_util_element_disabled(*find_args)
-      wait = Wait.new(timeout: Appom.max_wait_time)
-      wait.until { !Appom.driver.find_element(*find_args).enabled? }
+    def page
+      @page || Appom.driver
     end
   end
 end

data/lib/appom/section.rb

@@ -0,0 +1,28 @@
+module Appom
+  class Section
+    include Appium
+    include ElementContainer
+    include ElementFinder
+
+    attr_reader :root_element, :parent
+
+    def initialize(parent, root_element)
+      @parent = parent
+      @root_element = root_element
+    end
+
+    def page
+      root_element || super
+    end
+
+    def parent_page
+      candidate_page = parent
+      until candidate_page.is_a?(SitePrism::Page)
+        candidate_page = candidate_page.parent
+      end
+      candidate_page
+    end
+
+    private
+  end
+end

data/lib/appom/version.rb

@@ -1,3 +1,3 @@
 module Appom
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appom
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Harry.Tran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-28 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -65,7 +65,9 @@ files:
 - lib/appom.rb
 - lib/appom/cucumber.rb
 - lib/appom/element_container.rb
+- lib/appom/element_finder.rb
 - lib/appom/page.rb
+- lib/appom/section.rb
 - lib/appom/version.rb
 - lib/appom/wait.rb
 homepage: https://github.com/hoangtaiki/appom