true_automation 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48c26855f79dcfdbd0091ac78720fd929aa8a6bc
-  data.tar.gz: e994573a440d59bb959a75c4d30776518dd5faf8
+  metadata.gz: 6d70d37175ba346864ba424d243f4b5e3f218b11
+  data.tar.gz: 66b4f5bfb527b47227c22c05a27a7f3736d24caa
 SHA512:
-  metadata.gz: ef9e0068250ac084d49efd22aebf66080b2c30d03cdd2c00177d9a442ab0ba8e4f1c0f265cb21885d97c709fcef8f95967508fb4734bfb6086aff87ce9b52584
-  data.tar.gz: 220dacaf35c27ea05ddf9af26f73bd400e79a0331debe60d3ca83ea6132c8bcc01ac022e15c9316e9ac20b34fba912397fd468a6be3ea0e08340874eb286de96
+  metadata.gz: 7f45f020ed106d5d622ce870ea5b16caecfba6ce69cf6cc3ea66011ff4c1a539981b882b242de131e4f046e4b68d0dc2a8304c7b7fdac7960adc1d704309efc0
+  data.tar.gz: 05160e0aeb806872464410f085a089df63839b4bac3641adb92ff6abf457c2db595b9114b502c42238693a14c632c6a201cde487acd868f611eac8dc66a05f10

data/.gitignore

@@ -9,3 +9,4 @@
 
 .idea
 
+*.gem

data/README.md

@@ -1,43 +1,77 @@
 # TrueAutomation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/true_automation`. To experiment with that code, run `bin/console` for an interactive prompt.
+ **true_automation** gem enables awesome TrueAutomation.IO features for Capybara, Watir or Ruby-based Selenium projects. 
+    
+## Setup
 
-TODO: Delete this and the text above, and describe your gem
+**true_automation** gem provides helper DSL method, that can be used instead of Selenium/Capybara locators. 
+Initial setup aim is to make `ta` method visible for your code. 
 
-## Installation
+You need **trueautomation** npm package installed globally first. It requires NodeJS 9+. 
+We recommend to use [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows)
+to install Node.
 
-Add this line to your application's Gemfile:
+When right version of Node is installed run the following command:
 
-```ruby
-gem 'true_automation'
-```
+    $ npm install -g trueautomation
 
-And then execute:
 
-    $ bundle
+### Automatic Setup
 
-Or install it yourself as:
+Run `trueautomation init` inside your project directory. TrueAutomation installer automatically detects technology used 
+in your project. Currently we support Capybara/RSpec automatic setup only. 
 
-    $ gem install true_automation
+#### Capybara/RSpec
 
-## Usage
+For Capybara/RSpec projects TrueAutomation installer adds **true_automation** gem to the Gemfile, and includes TrueAutomation
+DSL to `rspec_helper.rb`. 
 
-TODO: Write usage instructions here
+#### Other
 
-## Development
+For other Ruby-based stacks installer just adds **true_automation** gem to the Gemfile. Check *Manual Setup* section for 
+setup guide.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Manual Setup
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Add this line to your application's Gemfile:
 
-## Contributing
+```ruby
+gem 'true_automation'
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/true_automation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+And then execute:
+
+    $ bundle install
+    
+Add TrueAutomation DSL to your test file
+
+ ```ruby
+ require 'true_automation/dsl'
+ ```
+ 
+ And include DSL into your class or just as the first line after `require` section.
+ 
+ ```ruby
+include TrueAutomation::DSL
+```
+
+## Usage
 
-## License
+Object is found by initial locator during the first run. We use advanced html tree and attributes analyzing algorithm which can find the object even if locator has been changed (id/classes are regenerated or HTML slightly changed).
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem provides helper method to use TrueAutomation.IO Smart Locators instead of Selenium or Capybara locators.
 
-## Code of Conduct
+To record an element for the first time use `ta(ta_name, initial_locator)` syntax.
 
-Everyone interacting in the TrueAutomation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/true_automation/blob/master/CODE_OF_CONDUCT.md).
+| Parameter | Description |
+|-----------------|-------------------------------------------------------------|
+|*ta_name*        | is TrueAutomation Element name. We recommend to use namespaced syntax. E.g. _pageName:widgetName:elementName_   |
+|*initial_locator*| is Selenium/Capybara locator to use to find element for the first time. If you change initial locator in your code, TrueAutomation element record will be rewritten during next test run                                       |
+
+For example:
+
+```ruby
+find(:xpath, ta('true:automation:name', '//initialXpathLocator'))
+find(:css, ta('true:automation:name', '.initialCSSSelector'))
+click(ta('true:automation:name', 'Login'))
+```

data/lib/true_automation/version.rb

@@ -1,3 +1,3 @@
 module TrueAutomation
-  VERSION = '0.1.0'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: true_automation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - TrueAutomation.IO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler