locatine 0.01839 → 0.01971

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6085cdba5bc5b209bf24330ded9e2458c045d3e3
-  data.tar.gz: '0678ca74613066d304d6d8408ec18ef2dc5575da'
+  metadata.gz: 7f657236dd233260c2ce19bfc4960c3f7a77ccaf
+  data.tar.gz: fd76da1f17ae3eed77e0b04dc2df3add1ecfbb2f
 SHA512:
-  metadata.gz: 10b9daf2cdd2139ddaf3f3054957ff467ba607681c692c6c7f3ea12c04b9d77845ab4a216003ccacdd6a84a5de901675f2708b2a17df967889d2a808c7dfbcfd
-  data.tar.gz: dfb7c5746b8219d8c90215c239d8aab91de686959911cd087d442a23d92e8564a8ff917f339cf2c22303b5722542f8fd32d61fea292b06b8196426741c680609
+  metadata.gz: 5c060f1f8c183113a1d3c95aac8612d889b03afeb439d5f41e676e7b3fe513bcb9082499f93616c4cb774a348aed91f45187e95b09c411caa8768a1cc292ea3a
+  data.tar.gz: 974782f877bdfd62faac8bee06ac8df307ae829d498e01db2ce6e6256d3506d351fe1281343695561b9bb477daf030c988fdfcc016923711142f7b20a94156ef

data/README.md

@@ -16,7 +16,7 @@ That's it.
 
 ## Stage of development:
 
-Version of Locatine is **0.01839** only. It means so far this is an early alfa. You can use it in a real project if you are really risky person.
+Version of Locatine is **0.01971** only. It means so far this is an early alfa. You can use it in a real project if you are really risky person.
 
 ## Installation
 
@@ -38,12 +38,14 @@ Or install it yourself as:
 
 1. Be sure that you have [Chrome browser](https://www.google.com/chrome/browser/desktop/) installed. It should work with any browser but something you can do in Chrome only
 2. Write the code
+
 ```ruby
 require 'locatine'
 s = Locatine::Search.new
 s.browser.goto("yourpage.com.com")
 s.find(name: "element", scope: "Main").click
 ```
+
 3. Run it in terminal with parameter LEARN=1 approximately like:
 
     $ LEARN=1 ruby path_to_your_test.rb
@@ -53,7 +55,7 @@ s.find(name: "element", scope: "Main").click
 6. Click Locatine application icon at the browser panel
 7. And confirm the selection
 
-![Steps 4-5-6](readme/567.png)
+![U can see an image here. On github)](readme/567.png)
 
 8. Now you can run the test without LEARN parameter and it will work.
 
@@ -275,8 +277,9 @@ scope.define
 
 You will be able to select all the elements and collections for scope one by one. When it is finished click "Abort Selection" button to exit the loop.
 
+You can force use dynamic variables on define where is possible (same rules as for find):
+
 ```ruby
-# You can force use dynamic variables on define where is possible (same rules as for find)
 vars = {text: "dynamic text",
         tag: "span",
         attrName: "part of dynamic attr-value"}
@@ -289,7 +292,26 @@ search.find(scope: "Name of scope",
             vars: vars # Necessary if elements were defined with vars)
 ```
 
-Scope itself is not very useful now. But we are looking forward.
+### Methods of scope
+
+If you want to get a hash with all elements that are defined in scope:
+
+```ruby
+# Lost elements will be found if possible!
+search.get_scope(name: "Name of scope").all
+# => {"element name": {
+#      elements: Array of Watir::Element,
+#      locator: valid xpath locator
+#      }...
+#    }
+```
+
+If you want to check presence of all elements:
+
+```ruby
+# Will raise an error if something lost!
+search.get_scope(name: "Name of scope").check
+```
 
 ## Other ways to use find
 

data/lib/locatine/app/manifest.json

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

data/lib/locatine/for_search/public.rb

@@ -118,6 +118,16 @@ module Locatine
         import_browser(value)
       end
 
+      ##
+      # Returns an instance of the Scope class. Starts define if learn == true
+      #
+      # Params:
+      #
+      # +name+ is a parameter that stores name of the scope.
+      # Default is "Default"
+      #
+      # +vars+ is a hash which will be used to generate dynamic attributes.
+      # See readme for explanation.
       def get_scope(name: 'Default', vars: {})
         answer = Scope.new(name, self)
         answer.define(vars) if @learn

data/lib/locatine/scope.rb

@@ -9,12 +9,77 @@ module Locatine
       @scope = scope
     end
 
+    ##
+    # Way to define locatine a bunch elements at once. Elements will be taken
+    # from user selection one by one and saved in scope.
+    #
+    # Params:
+    #
+    # +vars+ hash of vars used for dynamic attributes. Same as in :find
     def define(vars = {})
+      find_all(vars, false, true) if data.to_h != {}
+      new_define(vars)
+    end
+
+    ##
+    # Getting all the elements of the scope at once
+    #
+    # Params:
+    #
+    # +vars+ hash of vars used for dynamic attributes. Same as in :find
+    def all(vars = {})
+      find_all(vars)
+    end
+
+    ##
+    # Checking all the elements of the scope at once.
+    # Will fail if something was lost
+    #
+    # Params:
+    #
+    # +vars+ hash of vars used for dynamic attributes. Same as in :find
+    def check(vars = {})
+      success = []
+      result = find_all(vars, true)
+      result.each_pair do |name, hash|
+        success.push name if hash[:elements].nil?
+      end
+      raise "Check of #{@scope} failed! Lost: #{success}" unless success.empty?
+
+      result
+    end
+
+    private
+
+    def data
+      @search.data[@scope]
+    end
+
+    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 = { xpath: @search.send(:generate_xpath, hash, vars) }
+      { elements: elements, locator: locator }
+    end
+
+    def find_all(vars = {}, strict = false, define = false)
+      learn = @search.learn
+      @search.learn = define
+      result = {}
+      data.each_pair do |name, hash|
+        result[name] = find_one(name, hash, vars, strict)
+      end
+      @search.learn = learn
+      result
+    end
+
+    def new_define(vars)
       item = @search.send(:ask, @scope, '', nil, vars)
-      return if item[:element].nil?
+      return find_all(vars) if item[:element].nil?
 
       @search.send(:store, item[:attributes], @scope, item[:name])
-      define(vars)
+      new_define(vars)
     end
   end
 end

data/lib/locatine/version.rb

@@ -1,6 +1,6 @@
 module Locatine
   # constants here...
-  VERSION = '0.01839'.freeze
+  VERSION = '0.01971'.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.01839'
+  version: '0.01971'
 platform: ruby
 authors:
 - Sergei Seleznev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,7 +148,6 @@ files:
 - lib/locatine/scope.rb
 - lib/locatine/search.rb
 - lib/locatine/version.rb
-- readme/567.png
 homepage: https://github.com/sseleznevqa/locatine
 licenses:
 - MIT