marta 0.37396 → 0.41245

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12ec2a504a8d87171ea120513b7ec80d6db61961
-  data.tar.gz: c24afb174f328be3221a39274a1cc9ad22a925b7
+  metadata.gz: f8beee45c271c89a12e79a698eb47a90950a2ad0
+  data.tar.gz: be20dd4c88cfdce89c87b828b2230d0c30db9e19
 SHA512:
-  metadata.gz: 3d85be37f4bc4ee4911e51f8e26860951975dbbf28ae9dbc063f35a012523056b5a97fe017de0a48b66faac2049cdab43e95a176f0ffca224b5977fa06e9ceaf
-  data.tar.gz: 6c5de76ed3e580f77e132d4c4eea9dd6e943a57092a87d46eec4642807e5e454b1e211bfcc516e8176c6ee266ee399545eee60d34f4dfd6726ba30fd15a28477
+  metadata.gz: fd005959f827838be1424b933cfedac56f15523cf785bf8be86e5654e6565041e878bd5b81ac7e26c01efb75648339469b88c485b3c8d129052822ce7e8b4af4
+  data.tar.gz: 155842d7fb91435f72b2bfeca5bc13ffa21901c4832157197d1aae522249f00f7aaf45458df1e04408ae17bd52c386c0791090d82ba5e24b1857f922cd90a266

data/README.md

@@ -4,6 +4,10 @@ Marta was planned as an element locating tool for Watir tests. But now Marta is
 
 Also Marta is providing a little more stability when locating elements on the page.
 
+## Refactoring notification.
+
+Version 0.41245 (that one) is the version with new structure of data storing. Marta will try to convert old pajeobject json files to the new format automatically. But manual redefining is the safest way.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -64,28 +68,45 @@ your_page.your_element.click
 ## FAQ
 **Q: What if some attributes of elements will be changed?**
 
-*A: First of all at the defining stage you can exclude dynamic attributes. Also Marta has special Black Magic algorithm that will try to find the most similar element anyway.*
-
-*NOTE: Exclude attributes with empty values as well. In later versions Marta will filter them out automatically.*
+*A: Marta has her special Black Magic algorithm that will try to find the most similar element anyway.*
 
 **Q: What if I can locate element only by dynamic attributes like account_id?**
 
-*A: For example you want to find an element with the dynamic attribute "itemprop"*
+*A: For example you've got an element:*
+
+```html
+<span account_id="(notimportantpart)_2132">Account</span>
+```
+
+*where 2132 is a dynamic value that is not known at the begining of the test.*
 
-*First at the stage of page defining create a class variable itemprop = "anything".*
+*First at the stage of page defining create a class variable account_id = "anything".*
 
-![Dynamic attributes - 1](readme_files/itemprop.png)
+![Dynamic attributes - 1](readme_files/account_id.png)
 
 *After that you can dynamically change it in your code like*
 ```ruby
-your_page.itemprop # will be "anything" by default
-your_page.itemprop = "about"
+your_page.account_id # will be "anything" by default
+your_page.account_id = "2132"
 ```
-*And when defining an element you can use it in value field of itemprop like #{@itemprop}.*
+*At the stage of element defining you should be sure that your_page.account_id has your right value, just the same as in account_id attribute of your span. Just click on your span and Marta will remember that attribute automatically as an attribute with a dynamic part. Next time it will automatically change dynamic part of an attribute to your_page.account_id value.*
 
-![Dynamic attributes - 2](readme_files/itemprop2.png)
+*If there are two dynamic attributes that are containing the same dynamic part. Like:*
+```html
+<span account_id="(notimportantpart)_2132" value="2132">Account</span>
+```
+*You can use variable with name containing both. Like:*
+```ruby
+your_page.account_id_and_value #=> whatever was set by default at the page defining stage.
+your_page.account_id_and_value = "2132"
+```
+*Marta will understand it.*
 
-*See couple examples in example_project (Ruby checkbox, item1 and 2 radio buttons)*
+*You can see an example of it in exapmle_project. Page variable id_and_value_for_radio is related to attributes id and value of the radio buttons*
+
+**Q: And what about dynamic text?**
+
+*The same story. Your page variable name should include 'text'*
 
 **Q: I want to turn learning mode on\off in the code. How?**
 
@@ -142,6 +163,8 @@ TestPage.open_page("smthing.com") # Will navigate you to http://smthing.com
 *Predefined url way:*
 
 *At the step of the page defining set variable url = smthing.com*
+![Url way - 1](readme_files/urlway.png)
+*And in the code:*
 ```ruby
 dance_with
 test_page = TestPage.open_page # Will navigate you to http://smthing.com
@@ -151,6 +174,8 @@ test_page.url #=> "smthing.com"
 *The most flexible way:*
 
 *At the step of the page defining you set path = testpath*
+![Path way - 1](readme_files/pathway.png)
+*And in the code:*
 ```ruby
 dance_with base_url: "smthing.com"
 test_page = TestPage.open_page # Navigating you to http://smthing.com/testpath
@@ -177,9 +202,9 @@ test_page.method_edit("magic_button")
 
 *A: You can set tolerancy parameter. Larger = longer*
 ```ruby
-dance_with tolerancy: 1024# is the default value
+dance_with tolerancy: 100000# is the default value
 ```
-*That logic will be changed to more understandable soon. I hope.*
+*The amount = 100000 means that Marta will look for element 3 times (with different settings) trying up to 100000 xpaths each iteration. She will generate all possible combinations at first. When she's getting closer to the limit she's starting to try more random xpaths*
 
 **Q: Marta is trying to find the lost element after pretty long time. Why?**
 
@@ -213,9 +238,7 @@ engine.element(id: 'will_be_located_without_Marta')
 
 **Q: How can I find an invisible element? Or hardly clickable element with 1px size?**
 
-*A: At the stage of element defining you can see a button "Find by HTML". That button will open html code of your page in a special blue form. Find the html code of your element and click on it.*
-
-![HTML](readme_files/html.png)
+*A: At the stage of element defining you can open devtools. Just find the element you want to find and click Import from Devtools button*
 
 **Q: How can I find not just an element but a Watir::Radio for example?**
 
@@ -292,16 +315,16 @@ g_page.search "I am in love with selenium."
 
 **Q: What about an example?**
 
-*A: It is placed in example_project folder. All elements are defined already (except one that is not in use by default). For a tour do*
+*A: It is placed in example_project folder. All elements are defined already. For a tour do*
 
     $ cd example_project
     $ ./tests_with_learning.sh
 
-*Take a look at elements defining (especially when variable #{r_selection} is used). Try to redefine elements. Also take a look at the ruby code. There are some comments.*
+*Take a look at elements defining. Try to redefine elements. Also take a look at the ruby code. There are some comments.*
 
 **Q: What else?**
 
-*A: Nothing. Marta is under development. Her version is 0.37396. All the necessary features are working already but there are tons of things that should be done. And I am not a professional developer.*
+*A: Nothing. Marta is under development. Her version is 0.41245. All the necessary features are working already but there are tons of things that should be done. And I am not a professional developer.*
 
 ## Internal Design
 

data/example_project/p_object/test_page.rb

@@ -8,7 +8,8 @@ class MyTestPage < MartaTestPage
     some_field.set some
     # We will choose radio dynamically. Note:
     # the variable @r_select is defined at the page creation stage
-    @r_select = r_selection
+    @id_and_value_for_radio = r_selection
+    warn "r_select = #{@id_and_value_for_radio}"
     dynamic_radio.set
     dropbox.select selection
     dummy_checkbox.set if confirmed

data/example_project/project_itself/iframe.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <a href="https://github.com/sseleznevqa/marta">GITHUB link</a>
+  </body>
+</html>

data/{lib/marta/data/test.html → example_project/project_itself/index.html}

@@ -2,7 +2,7 @@
   <title>Example page</title>
   <body>
     <h1 id='Title'>Test page</h1>
-    <iframe src="/welcome" width=300 height=300></iframe>
+    <iframe src="iframe.html" width=300 height=300></iframe>
     <form>
       <input type='text' class='some' placeholder='utka'>
       <select custom='custom'>

data/example_project/spec/p_object/pageobjects/MartaTestPage.json

@@ -1,182 +1,765 @@
 {
-  "vars": {
-    "path": "test",
-    "r_select": "notdefined",
-    "url": ""
-  },
   "meths": {
     "numbers": {
       "options": {
-        "collection": true,
-        "self": "LI",
-        "not_self": null,
-        "pappy": "UL",
-        "not_pappy": null,
-        "granny": "FORM",
-        "not_granny": null
-      },
-      "not_self": null,
-      "not_pappy": null,
-      "not_granny": null,
-      "self": {
-        "class": [
-          "collection"
-        ]
-      },
-      "pappy": {
-      },
-      "granny": {
+        "collection": true
+      },
+      "positive": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+            "LI"
+          ],
+          "attributes": {
+            "class": [
+              "collection"
+            ]
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+            "UL"
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+            "FORM"
+          ],
+          "attributes": {
+          }
+        }
+      },
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "some_field": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "BODY",
-        "pappy": "FORM",
-        "self": "INPUT"
-      },
-      "pappy": {
-      },
-      "self": {
-        "class": [
-          "some"
-        ],
-        "placeholder": "utka",
-        "type": "text"
+        "collection": false
+      },
+      "positive": {
+        "self": {
+          "tag": [
+            "INPUT"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+            "class": [
+              "some"
+            ],
+            "placeholder": [
+              "utka"
+            ],
+            "type": [
+              "text"
+            ]
+          }
+        },
+        "pappy": {
+          "tag": [
+            "FORM"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "BODY"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
+      },
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "dynamic_radio": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "FORM",
-        "pappy": "DIV",
-        "self": "INPUT"
-      },
-      "pappy": {
-      },
-      "self": {
-        "id": "choice#{@r_select}",
-        "name": "contact",
-        "type": "radio",
-        "value": "#{@r_select}"
+        "collection": false
+      },
+      "positive": {
+        "self": {
+          "tag": [
+            "INPUT"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+            "id": [
+              "choice1"
+            ],
+            "name": [
+              "contact"
+            ],
+            "type": [
+              "radio"
+            ],
+            "value": [
+              "1"
+            ]
+          }
+        },
+        "pappy": {
+          "tag": [
+            "DIV"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "FORM"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
+      },
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "dropbox": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "BODY",
-        "pappy": "FORM",
-        "self": "SELECT"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "tag": [
+            "SELECT"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+            "custom": [
+              "custom"
+            ]
+          }
+        },
+        "pappy": {
+          "tag": [
+            "FORM"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "BODY"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "custom": "custom",
-        "retrieved_by_marta_text": "\n        "
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "dummy_checkbox": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "FORM",
-        "pappy": "DIV",
-        "self": "INPUT"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "tag": [
+            "INPUT"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+            "name": [
+              "checkbox"
+            ],
+            "type": [
+              "checkbox"
+            ],
+            "value": [
+              "checkbox"
+            ]
+          }
+        },
+        "pappy": {
+          "tag": [
+            "DIV"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "FORM"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "name": "checkbox",
-        "type": "checkbox",
-        "value": "checkbox"
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "confirmation_message": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "HTML",
-        "pappy": "BODY",
-        "self": "H1"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "text": [
+            "1st button was clicked"
+          ],
+          "tag": [
+            "H1"
+          ],
+          "attributes": {
+            "id": [
+              "Title"
+            ]
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+            "BODY"
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+            "HTML"
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "id": "Title",
-        "retrieved_by_marta_text": "1st button was clicked"
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "second_button": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "BODY",
-        "pappy": "FORM",
-        "self": "BUTTON"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "tag": [
+            "BUTTON"
+          ],
+          "text": [
+            "Second button"
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "tag": [
+            "FORM"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "BODY"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "retrieved_by_marta_text": "Second button"
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "title": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "HTML",
-        "pappy": "BODY",
-        "self": "H1"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "text": [
+            "Test page"
+          ],
+          "tag": [
+            "H1"
+          ],
+          "attributes": {
+            "id": [
+              "Title"
+            ]
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+            "BODY"
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+            "HTML"
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "id": "Title",
-        "retrieved_by_marta_text": "Test page"
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "first_button": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "BODY",
-        "pappy": "FORM",
-        "self": "INPUT"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "tag": [
+            "INPUT"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+            "onclick": [
+              "document.getElementById(\"Title\").innerHTML",
+              "=",
+              "\"1st",
+              "button",
+              "was",
+              "clicked\""
+            ],
+            "type": [
+              "button"
+            ],
+            "value": [
+              "First",
+              "button"
+            ]
+          }
+        },
+        "pappy": {
+          "tag": [
+            "FORM"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "BODY"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "type": "button",
-        "value": "First button"
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     },
     "the_iframe": {
-      "granny": {
-      },
       "options": {
-        "collection": false,
-        "granny": "HTML",
-        "pappy": "BODY",
-        "self": "IFRAME"
+        "collection": false
       },
-      "pappy": {
+      "positive": {
+        "self": {
+          "tag": [
+            "IFRAME"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+            "height": [
+              "300"
+            ],
+            "src": [
+              "iframe.html"
+            ],
+            "width": [
+              "300"
+            ]
+          }
+        },
+        "pappy": {
+          "tag": [
+            "BODY"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "tag": [
+            "HTML"
+          ],
+          "text": [
+
+          ],
+          "attributes": {
+          }
+        }
       },
-      "self": {
-        "height": "300",
-        "src": "/welcome",
-        "width": "300"
+      "negative": {
+        "self": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "pappy": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        },
+        "granny": {
+          "text": [
+
+          ],
+          "tag": [
+
+          ],
+          "attributes": {
+          }
+        }
       }
     }
+  },
+  "vars": {
+    "id_and_value_for_radio": "notdefined",
+    "path": "index.html",
+    "url": ""
   }
 }