locatine 0.03050 → 0.03118

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec7ffd6c0a45544ae5cbd20581f72190bbfa3ee5dd2c5e444740c1d03d7ba04
-  data.tar.gz: 7552e77cfc41106c4679a99554980f67ad4decc354348ee0d01479c9799687fa
+  metadata.gz: b992087a77664cfe04949ab6bb1f343edb0c03801bcc118ac21631c4455463f3
+  data.tar.gz: b0d586f4c4de1c38a84eee4d1f9e434a3d8136d4ae25e83367dc573a5ec67c76
 SHA512:
-  metadata.gz: 6d42ad78b43ff2335357546b50daa98734e1d06527e26fc6608540135ffb73d4f1aebcf9b5e3fb44c74b3125a31045b3206a8ddabdc0c08211f28f71390fdc9f
-  data.tar.gz: 2b752ff4e3a7b60ae8eb12f585eef9df6445f3c659169e7470bcfbc18f848938762815a8a977ce4825be250f527a425b0c2ff1b96d52240db4223e9d1d8a201e
+  metadata.gz: 59ae3ed8e6aa6ac27be09e3bcaeda8e4ce7968db40e8393efd0fe47aeb25be5770181c718555ed304a1938133e7c198b788e82adbf557acb1e451aa650d90d6e
+  data.tar.gz: b56c011bb15c36a1e42dd342f2cc0f09f21ad65835d3cdf457e20b915b18faaeb381bf3c9328b705e6b4a6ec613ebc17712e0cfead1de2e094905509bb50fbe8

data/README.md

@@ -14,11 +14,7 @@ That's it.
 
 ## Stage of development:
 
-Version of Locatine is **0.03050**. The 4th version since rewriting. 5-15 next versions is dedicated to bug fixing, tweaking.
-
-## Attention
-
-This version of Locatine is not compatible to previous.
+Version of Locatine is **0.03118**.
 
 ## Installation
 

data/lib/locatine/element.rb

@@ -12,9 +12,11 @@ module Locatine
     ##
     # Init method
     #
-    # +session+ is a Locatine::Session instance
-    # +element_code+ is an element hash returned by selenium it is shaped like:
-    # {"element-6066-11e4-a52e-4f735466cecf"=>"c95a0580-4ac7-4c6d-..."}
+    # @param session [Locatine::Session instance]
+    # @param element_code [Hash] is an element hash returned by selenium,
+    #   it is shaped like:
+    #
+    #   +{"element-6066-11e4-a52e-4f735466cecf"=>"c95a0580-4ac7-4c6d-..."}+
     def initialize(session, element_code)
       unless element_code
         raise ArgumentError, 'Cannot init element with no element data'

data/lib/locatine/results.rb

@@ -21,23 +21,30 @@ module Locatine
     ##
     # Method to find elements
     #
-    # +session+ instance of Locatine::Session
-    # +locator+ can be a classic locator shaped for webdriver protocol like:
-    # {'using => 'xpath', 'value' => '//div'} or
-    # {'using' => 'css selector', 'value' => 'div'}
-    # It also can be a locator with magic comment like
-    # {'using' => 'css selector', 'value' => 'div/*magic comment*/'}
-    # It also can be a locator with incapsulated json
-    # {'using' => 'css selector', 'value' => 'div/*{"name": "magic comment"}*/'}
-    # It can be a locatine locator
-    # {'using' => 'locatine', 'value' => '{"name": "magic comment"}'} or
-    # {'using' => 'locatine', 'value' => 'magic comment'
-    # +parent+ is the parent element to look for the nested ones.
+    # @param session [Locatine::Session]
+    # @param locator [Hash] can be a classic locator shaped for webdriver
+    #   protocol like:
+    #
+    #   +{'using => 'xpath', 'value' => '//div'}+ or
+    #   +{'using' => 'css selector', 'value' => 'div'}+
+    #
+    #   It also can be a locator with magic comment like:
+    #
+    #   +{'using' => 'css selector', 'value' => 'div/*magic comment*/'}+
+    #
+    #   It also can be a locator with incapsulated json
+    #
+    #   +{'using' => 'css selector', 'value' => 'div/*{"name": "magic "}*/'}+
+    #
+    #   It can be a locatine locator
+    #
+    #   +{'using' => 'locatine', 'value' => '{"name": "magic comment"}'}+ or
+    #   +{'using' => 'locatine', 'value' => 'magic comment'}+
+    # @param parent is the parent element to look for the nested ones.
+    # @return class instance populated by results or an empty array
     def find(session, locator, parent)
       configure(session, locator, parent)
-      timer
-      classic_find
-      guess if name_only?
+      find_routine
       return self unless empty?
 
       find_by_magic if known && tolerance.positive?
@@ -56,6 +63,15 @@ module Locatine
 
     private
 
+    def find_routine
+      timer
+      classic_find
+      guess if name_only?
+      return if first.class == Locatine::Error || empty?
+
+      log_found if name_only?
+    end
+
     def simple_find
       path = @parent ? "/element/#{@parent}/elements" : '/elements'
       response = @session.api_request(path, 'Post', @locator.to_json)

data/lib/locatine/results_helpers/comparing.rb

@@ -3,7 +3,7 @@
 module Locatine
   module ResultsHelpers
     #
-    # Trying to guess element here
+    # Trying to compare elements here
     module Comparing
       private
 

data/lib/locatine/results_helpers/config.rb

@@ -3,7 +3,7 @@
 module Locatine
   module ResultsHelpers
     #
-    # Trying to guess element here
+    # Trying to configure results here
     module Config
       private
 

data/lib/locatine/results_helpers/find_by_magic.rb

@@ -19,8 +19,8 @@ module Locatine
       def classic_thread
         Thread.new do
           while empty?
-            sleep 0.5
             classic_find
+            sleep 1
           end
         end
       end

data/lib/locatine/session.rb

@@ -16,8 +16,8 @@ module Locatine
     ##
     # Init of the new session instance
     #
-    # +selenium+ is a selenium address like "https://host:port"
-    # +session+ is a session id provided by selenium
+    # @param selenium [String] is a selenium address like +"https://host:port"+
+    # @param session [String] is a session id provided by selenium
     def initialize(selenium, session)
       @selenium = selenium
       @parsed_selenium = URI.parse @selenium
@@ -31,7 +31,8 @@ module Locatine
     ##
     # This method is to set settings
     #
-    # +params+ is a hash of settings like {json: "some", depth: 0...}
+    # @param params [Hash] is for settings like +{json: "some", depth: 0...}+
+    # @return params hash :)
     def configure(params)
       params.to_h.each_pair do |var, value|
         instance_variable_set("@#{var}", value)
@@ -44,10 +45,13 @@ module Locatine
     # Find method is for finding elements.
     #
     # That is the part that is replacing simple finding by selenium
-    # +params+ is a hash of settings like {json: "some", depth: 0...}
-    # +parent+ is an element code of the element to look under. It is counted
-    # only for the most simple search. If element is lost parent will be
-    # ignored
+    # @param params [Hash] is for settings like +{json: "some", depth: 0...}+
+    # @param parent [String] is an element code of the element to look under.
+    #   It is counted
+    #   only for the most simple search. If element is lost parent will be
+    #   ignored
+    # @return populated instance of Locatine::Results or an empty array
+    #   or Locatine::Error
     def find(params, parent = nil)
       find_routine(params, parent)
     rescue RuntimeError => e
@@ -60,10 +64,10 @@ module Locatine
     ##
     # Session can execute js scripts on a page
     #
-    # Note this method will be not called when you are asking selenoum via
-    # locatine to execute a script. This class is for internal use.
-    # +script+ some valid js code
-    # +*args+ arguments to be passed to script.
+    # @note This method will be not called when you are asking selenum via
+    #   locatine to execute a script. This method is for internal use only.
+    # @param script [String] some valid js code
+    # @param *args [Array] arguments to be passed to script.
     def execute_script(script, *args)
       args.map! { |item| item.class == Locatine::Element ? item.answer : item }
       response = api_request('/execute/sync', 'Post',
@@ -89,9 +93,13 @@ module Locatine
     #
     # We are using it to ask for elements found by selenium or
     # for script execution
-    # +path+ is a relative path to call on selenium like '/elements'
-    # +method+ is an http method to perform ('Get', 'Post', etc.)
-    # +body+ is for request data. json here (selenium wants it) or nil
+    # @param path [String] is a relative path to call on selenium like
+    #   +'/elements'+
+    # @param method [String] is an http method to perform ( +'Get'+, +'Post'+,
+    #   etc.)
+    # @param body [String] is for request data. Json here (selenium wants it)
+    #   or nil
+    # @return result of call whatever it is
     def api_request(path, method, body)
       uri = call_uri(path)
       req = Net::HTTP.const_get(method)

data/lib/locatine/version.rb

@@ -2,7 +2,7 @@
 
 module Locatine
   # constants here...
-  VERSION = '0.03050'
+  VERSION = '0.03118'
   NAME = 'locatine'
   HOME = if File.readable?("#{Dir.pwd}/lib/#{Locatine::NAME}")
            "#{Dir.pwd}/lib/#{Locatine::NAME}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locatine
 version: !ruby/object:Gem::Version
-  version: '0.03050'
+  version: '0.03118'
 platform: ruby
 authors:
 - Sergei Seleznev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler