locatine 0.02007 → 0.02058

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d489c3b40e3742d4a0133a1280587c338879b7c
-  data.tar.gz: 3347799276e7b897802781ce57cfc1d480c61b77
+  metadata.gz: 839233263a07aac6fda720392d0dbd920a5a9660
+  data.tar.gz: b60a4fdc5d93b96abb65b49c128302eb73d5a9b6
 SHA512:
-  metadata.gz: 794115b0c100ed8724bce73059ec80c8b39e2d91022ce4a0710838e976faba02be568096477c6b3482a0b591d0cdda90e7a09c3ad15b41b0323286ebd271ea24
-  data.tar.gz: 457935ca593e60dd278cfd18c8aad043f366c7fb8f79197139ddcea79d1cd196b78f2063e7e8f9be0455693568d6a787a7b9ada4e1aa28ce320de739194bdb63
+  metadata.gz: f6279a2237def4ac7799e8a1ed6f3d293251d92ad7e2a62e13fd98ac22b05c2d4bccaabd4be19cf9de97f27a28a98916d784236af6240109ccb61323481dd7be
+  data.tar.gz: f1f87a3f394b2091d0391e53e3844067e6c929d51dfc68e2d526a0dd44dd588ce293752044e9c27602997f3d9b2d43c27e1fb657683387761079fae9b81d5f65

data/README.md

@@ -16,7 +16,7 @@ That's it.
 
 ## Stage of development:
 
-Version of Locatine is **0.02007** only. It means so far this is an alfa. You can use it in a real project if you are a risky person.
+Version of Locatine is **0.02058** only. It means so far this is an alfa. You can use it in a real project if you are a risky person.
 
 ## Installation
 
@@ -95,7 +95,8 @@ Locatine::Search.new(json: "./Locatine_files/default.json",
                      stability_limit: 1000,
                      scope: "Default",
                      tolerance: 33,
-                     visual_search: false)
+                     visual_search: false,
+                     no_fail: false)
 ```
 
 ### json
@@ -142,6 +143,10 @@ Position and size for element will be stored for the current resolution only. St
 
 Be careful! Set true only if appearance of your page is pretty stable.
 
+### no_fail
+
+When element is lost and no_fail is true you will get nil for single element and [] for collection. If no_fail is false (which is default) and locatine cannot find something you will face an error.
+
 ## Changing options on fly
 
 You can get or set these values on fly. Like:
@@ -164,7 +169,8 @@ s.find(name: "some name",
        iframe: nil,
        return_locator: false,
        collection: false,
-       tolerance: nil)
+       tolerance: nil,
+       no_fail: nil)
 ```
 ### name
 
@@ -174,26 +180,6 @@ should be always provided. Name of element to look for. Must be uniq one per sco
 
 group of elements. Must be uniq per file. This is to help to store elements with same names from different pages in one file
 
-### exact
-
-unless it is true locatine will always try to find lost element using all the power it has. Use exact: true if you want element to be lost in case of any significant change. If it is impossible to find element when exact: true locatine will return nil.
-
-Be carefull: exact is working only when element is stable (has at least one parameter persistent for stability_limit times == well known by locatine). If element is not stable yet locatine will search for it anyway and maybe it will find something. So if you want to ensure that element does not exist you should use locator and exact at the same time. You may also set zero tolerance. Check it:
-
-```ruby
-# Will return nil if there is no element id = 'not welcome'
-s.find(name: "unexpected element", locator:{id: "not welcome"}, exact: true)
-
-# Will return nil if well known element "unexpected element" is not present
-# Will try to find and return at least something if "unexpected element" is not stable (well known)
-# If there is nothing similar to "unexpected element" returns nil
-s.find(name: "unexpected something", exact: true)
-
-# Will return element only if the same element is present
-# Changing of any attribute which is trusted by locatine will produce nil
-s.find(name: "unexpected something", exact: true, tolerance: 0)
-```
-
 ### locator
 
 you may provide your own locator to use. Same syntax as in Watir:
@@ -263,6 +249,14 @@ if true array of elements will be returned. If false only the one element (the f
 
 You can state custom tolerance for the element.
 
+### exact
+
+It is disabling attempts to find element by advanced algorithms. If locator is provided find method will use only locator. If there is no locator only the basic search will be performed.
+
+### no_fail
+
+no_fail option that will work for that search only.
+
 ## Scope
 
 If you want to define a whole bunch of elements at once you can do:
@@ -302,7 +296,8 @@ search.get_scope(name: "Name of scope").all
 # => {"element name": {
 #      elements: Array of Watir::Element,
 #      locator: valid xpath locator
-#      }...
+#      },
+#     "next element name":...
 #    }
 ```
 
@@ -343,3 +338,12 @@ s.collect("group of elements") # Will return an array
 # or
 s.collect(name: "group of elements")
 ```
+
+Also:
+
+```ruby
+s.exact_collection(name: "something") == s.collect(exact: true, name: "something")
+s.exact(name: "something") == s.find(name: "something", exact: true)
+s.check(name: "something") == s.find(name: "something", tolerance: 0)
+s.check_collection(name: "something") == s.collect(name: "something", tolerance: 0)
+```

data/lib/locatine/app/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "Locatine app",
-  "version": "0.02007",
+  "version": "0.02058",
   "description": "Messaging from browser to main app",
   "devtools_page": "devtools.html",
   "permissions": ["activeTab", "storage", "contextMenus", "tabs"],

data/lib/locatine/for_search/file_work.rb

@@ -54,6 +54,7 @@ module Locatine
       ##
       # Saving json
       def store(attributes, scope, name)
+        @data[scope][name] = {} if @learn
         @data[scope][name] = set_stability(attributes, @data[scope][name])
         to_write = { 'data' => @data }
         File.open(@json, 'w') do |f|

data/lib/locatine/for_search/find_by_magic.rb

@@ -7,13 +7,13 @@ module Locatine
 
       ##
       # Getting all the elements via black magic
-      def find_by_magic(name, scope, data, vars, exact)
+      def find_by_magic(name, scope, data, vars)
         warn_element_lost(name, scope)
         @cold_time = 0
         all = all_options(data, vars)
         @cold_time = nil
-        raise_not_found(name, scope) if all.empty? && !exact
-        suggest_by_all(all, data, vars, name, scope, exact)
+        raise_not_found(name, scope) if all.empty? && !@current_no_f
+        suggest_by_all(all, data, vars, name, scope)
       end
 
       def similar_enough(data, attributes)
@@ -30,11 +30,10 @@ module Locatine
         return suggest, attributes
       end
 
-      def suggest_by_all(all, data, vars, name, scope, exact)
+      def suggest_by_all(all, data, vars, name, scope)
         suggest, attributes = best_of_all(all, vars)
         ok = similar_enough(data, attributes) unless suggest.nil?
-        spawn = !ok && !exact
-        raise_not_similar(name, scope) if spawn
+        raise_not_similar(name, scope) if !ok && !@current_no_f
         if ok
           warn_lost_found(name, scope)
           return suggest, attributes

data/lib/locatine/for_search/find_logic.rb

@@ -11,20 +11,12 @@ module Locatine
         name
       end
 
-      def stable?(attributes)
-        s = []
-        attributes.each_pair do |_depth, array|
-          s.push array.max_by { |i| i['stability'].to_i }['stability'].to_i
-        end
-        s.max >= @stability_limit
-      end
-
       def data_search(name, scope, vars, exact)
         result = find_by_data(@data[scope][name], vars)
         attributes = generate_data(result, vars) if result
-        if !result && (!exact || !stable?(@data[scope][name]))
+        if !result && !exact
           result, attributes = find_by_magic(name, scope,
-                                             @data[scope][name], vars, exact)
+                                             @data[scope][name], vars)
         end
         return result, attributes
       end
@@ -38,7 +30,7 @@ module Locatine
 
       def full_search(name, scope, vars, locator, exact)
         result, attributes = search_steps(name, scope, vars, locator, exact)
-        raise_not_found(name, scope) if !result && !exact
+        raise_not_found(name, scope) if !result && !@current_no_f
         store(attributes, scope, name) if result
         return result, attributes
       end
@@ -69,11 +61,13 @@ module Locatine
       #
       # +collection+ nil, true or false
       def to_subtype(result, collection)
+        result = result.to_a
+        to_return = result.map(&:to_subtype)
         case collection
         when true
-          result
+          to_return
         when false
-          result.first.to_subtype
+          to_return.first
         end
       end
     end

data/lib/locatine/for_search/helpers.rb

@@ -26,10 +26,11 @@ module Locatine
         @iframe = @browser.iframe(@iframe.selector) if @iframe && @iframe.stale?
       end
 
-      def set_env_for_search(look_in, iframe, tolerance)
+      def set_env_for_search(look_in, iframe, tolerance, no_fail)
         @type = look_in
         @iframe = iframe
         @current_t = tolerance || @tolerance
+        @current_no_f = no_fail || @no_fail
       end
 
       def not_magic_div

data/lib/locatine/for_search/public.rb

@@ -35,7 +35,8 @@ module Locatine
                      stability_limit: 1000,
                      scope: 'Default',
                      tolerance: 67,
-                     visual_search: false)
+                     visual_search: false,
+                     no_fail: false)
         import_browser browser
         import_file(json)
         @depth = depth
@@ -44,6 +45,7 @@ module Locatine
         @scope = scope
         @tolerance = tolerance
         @visual_search = visual_search
+        @no_fail = no_fail
       end
 
       ##
@@ -88,14 +90,16 @@ module Locatine
                iframe: nil,
                return_locator: false,
                collection: false,
-               tolerance: nil)
+               tolerance: nil,
+               no_fail: nil)
         name = set_name(simple_name, name)
-        set_env_for_search(look_in, iframe, tolerance)
+        set_env_for_search(look_in, iframe, tolerance, no_fail)
         scope ||= @scope.nil? ? 'Default' : @scope
         result, attributes = full_search(name, scope, vars, locator, exact)
         return { xpath: generate_xpath(attributes, vars) } if result &&
                                                               return_locator
-        return to_subtype(result, collection) if result && !return_locator
+
+        to_subtype(result, collection)
       end
 
       ##
@@ -133,6 +137,30 @@ module Locatine
         answer.define(vars) if @learn
         answer
       end
+
+      ##
+      # Find alias with zero tolerance option enforced
+      def check(*args)
+        enforce({ tolerance: 0 }, *args)
+      end
+
+      ##
+      # Collection alias with zero tolerance option enforced
+      def check_collection(*args)
+        enforce({ tolerance: 0, collection: true }, *args)
+      end
+
+      ##
+      # Collection alias with exact option on
+      def exact_collection(*args)
+        enforce({ exact: true, collection: true }, *args)
+      end
+
+      ##
+      # Find alias with exact option on
+      def exact(*args)
+        enforce({ exact: true }, *args)
+      end
     end
   end
 end

data/lib/locatine/for_search/saying.rb

@@ -91,10 +91,25 @@ module Locatine
         push_title "#{length} #{verb(length)} selected as #{name} in #{scope}."\
         " But it was already defined #{found.length} times."
         example = found.sample
+        same = found.select { |i| (i[:name] == name) && (i[:scope] == scope) }
+        if same.empty?
+          send_same_entry_example(example)
+        else
+          send_fully_similar
+        end
+      end
+
+      def send_same_entry_example(example)
         send_to_app('locatinehint', "For example like #{example[:name]} in"\
         " #{example[:scope]}")
       end
 
+      def send_fully_similar
+        send_to_app('locatinehint', 'And it was defined with the same name'\
+        ' and in the same scope. So saving your selection will cause'\
+        ' deleting of all previously stored data about the element')
+      end
+
       def warn_dropping(tag, index)
         send_warn('For some reason locatine cannot proceed with'\
           " //#{tag}[#{index}] element. You've selected. Maybe element was"\

data/lib/locatine/scope.rb

@@ -42,7 +42,7 @@ module Locatine
       success = []
       result = find_all(vars, true)
       result.each_pair do |name, hash|
-        success.push name if hash[:elements].nil?
+        success.push name if hash[:elements].empty?
       end
       raise "Check of #{@scope} failed! Lost: #{success}" unless success.empty?
 
@@ -58,7 +58,9 @@ module Locatine
     def find_one(name, hash, vars, strict)
       locator = { xpath: @search.send(:generate_xpath, hash, vars) } if strict
       elements = @search.collect(scope: @scope, name: name,
-                                 locator: locator, exact: strict)
+                                 locator: locator,
+                                 exact: strict,
+                                 no_fail: strict)
       locator = { xpath: @search.send(:generate_xpath, hash, vars) }
       { elements: elements, locator: locator }
     end

data/lib/locatine/search.rb

@@ -52,7 +52,8 @@ module Locatine
                   :stability_limit,
                   :scope,
                   :tolerance,
-                  :visual_search
+                  :visual_search,
+                  :no_fail
     attr_reader   :json,
                   :browser
   end

data/lib/locatine/version.rb

@@ -1,6 +1,6 @@
 module Locatine
   # constants here...
-  VERSION = '0.02007'.freeze
+  VERSION = '0.02058'.freeze
   NAME = 'locatine'.freeze
   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.02007'
+  version: '0.02058'
 platform: ruby
 authors:
 - Sergei Seleznev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler