page_magic 1.2.6 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5f5e27b2a270ba1333f9ae3b00500892ca2db6ea
-  data.tar.gz: adb6f8c204b92c581ae8d05198899f1fe54decb9
+SHA256:
+  metadata.gz: 4eec3ec93f7cd6ba430ba78860160822632cdc8949da2aea83afddc3366ea3d3
+  data.tar.gz: e3b3634979f0499bd0db1012a209a2d12cce94b7c0b870b1e91d3f8048e3f92b
 SHA512:
-  metadata.gz: 220f194ecca9dc7ddcb6f912d0ea45caf922dc2704011e4fc5d897382d8af1d0a2a9725db585767d23a9913ad0f387e258dc0d9b73545290a25bb181b9e82578
-  data.tar.gz: aeefe035655fc201c01d4539026be9162fea73fe7e173314ce0fe7389529d089507af383299727307598b1e0c406a576a55f160f38f5128df201dde38f2fa167
+  metadata.gz: afe8591e16f7afaa2e464b48ac9eabff046a140df8558dee5bb51aa3eac0ccb43c43cbb43eb7af9d7a2529f242f1cc87b7f63160c5c70decb3bbc9d2cd8d060a
+  data.tar.gz: 95802bd6ab8e1acca9f0d8142452469a743177cdbbf3a44e679016960a23bfe56b453ad53db758bd9ce9edc82f388f90a03c72f76341c24ff517995678e9f2eb

data/.rubocop.yml

@@ -2,8 +2,10 @@ Metrics/LineLength:
   Max: 120
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.7
   Exclude:
+    - 'lib/active_support/**/*'
+    - 'spec/lib/active_support/**/*'
     - 'pkg/**/*'
     - 'vendor/**/*'
     - 'coverage/**/*'
@@ -16,5 +18,19 @@ Metrics/ParameterLists:
 Metrics/MethodLength:
   Max: 11
 
-Style/MethodMissing:
-  Enabled: false
+#Style/MethodMissing:
+#  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+   - 'spec/**/*'
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'

data/.simplecov

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'pullreview/coverage'
-require "codeclimate-test-reporter"
 
-SimpleCov.formatters  = [SimpleCov::Formatter::HTMLFormatter,PullReview::Coverage::Formatter,CodeClimate::TestReporter::Formatter]
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, PullReview::Coverage::Formatter]
 
 SimpleCov.start do
   add_filter '/spec/'
-end
+  add_filter '/lib/active_support/core_ext/object/to_query.rb'
+end

data/.zsh_config

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+#alias bundle="docker run -v ${HOME}/.gitconfig:/root/.gitconfig -v $(pwd):/page_magic -t lvl-up/page-magic bundle"
+#alias ruby="bundle exec ruby"
+#alias rake="bundle exec rake"
+#alias rubocop="bundle exec rubocop"
+#alias gem="docker run -v $(pwd):/page_magic -t lvl-up/page-magic gem"

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.7.2-alpine
+
+ENV APP_HOME /page_magic
+RUN mkdir $APP_HOME
+
+COPY . $APP_HOME
+WORKDIR $APP_HOME
+
+RUN apk --update --no-cache add build-base git
+RUN bundle install

data/Gemfile

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'capybara', '>= 2.5'
-gem 'activesupport', '~> 4'
+gem 'activesupport'
+gem 'capybara', ">=3.0"
 
 group :test do
-  gem 'watir-webdriver'
-  gem 'sinatra'
+  gem 'poltergeist'
   gem 'rspec', require: 'rspec/core/rake_task'
   gem 'simplecov', require: false
-  gem 'poltergeist'
-  gem 'codeclimate-test-reporter', group: :test, require: nil
-  gem 'pullreview-coverage', require: false
-  gem 'arbre'
+  gem 'sinatra'
+  gem 'watir'
 end
 
 group :development do
-  gem 'jeweler', '~> 2.0'
-  gem 'rubocop', '~> 0.34', require: 'rubocop/rake_task'
+  gem 'github-markup'
+  gem 'jeweler'
+  gem 'redcarpet'
+  gem 'rubocop', require: 'rubocop/rake_task'
+  gem 'ruby-debug-ide', require: false
   gem 'yard', '~> 0.8'
-  gem 'redcarpet', '~> 3.3'
-  gem 'github-markup', '~> 1.4'
 end

data/Gemfile.lock

@@ -1,167 +1,174 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.7)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.4.0)
-    arbre (1.1.1)
-      activesupport (>= 3.0.0)
-    ast (2.3.0)
-    builder (3.2.2)
-    capybara (2.7.1)
+    ast (2.4.2)
+    builder (3.2.4)
+    capybara (3.35.3)
       addressable
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      xpath (~> 2.0)
-    certifi (2016.02.28)
-    childprocess (0.5.9)
-      ffi (~> 1.0, >= 1.0.11)
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    childprocess (3.0.0)
     cliver (0.3.2)
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
+    concurrent-ruby (1.1.8)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.14)
-    git (1.3.0)
-    github-markup (1.4.0)
-    github_api (0.14.4)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    github-markup (4.0.0)
+    github_api (0.16.0)
       addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
       hashie (>= 3.4)
-      oauth2 (~> 1.0.0)
-    hashie (3.4.4)
-    highline (1.7.8)
-    i18n (0.7.0)
-    jeweler (2.1.1)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (4.1.0)
+    highline (2.0.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jeweler (2.3.9)
       builder
-      bundler (>= 1.0)
+      bundler
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.16.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
+      psych
       rake
       rdoc
-      semver
-    json (1.8.3)
-    jwt (1.5.4)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    multi_json (1.12.1)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      semver2
+    jwt (2.2.2)
+    mime-types (2.99.3)
+    mini_mime (1.1.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    parser (2.3.1.2)
-      ast (~> 2.2)
-    pkg-config (1.1.7)
-    poltergeist (1.10.0)
-      capybara (~> 2.1)
+      rack (>= 1.2, < 3)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    poltergeist (1.18.1)
+      capybara (>= 2.1, < 4)
       cliver (~> 0.3.1)
       websocket-driver (>= 0.2.0)
-    powerpack (0.1.1)
-    pullreview-coverage (0.0.5)
-      certifi
-      simplecov (>= 0.7.1, < 1.0.0)
-    rack (1.6.4)
-    rack-protection (1.5.3)
+    psych (3.3.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rainbow (2.1.0)
-    rake (11.2.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
-    redcarpet (3.3.4)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.1)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rchardet (1.8.0)
+    rdoc (6.3.0)
+    redcarpet (3.5.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.42.0)
-      parser (>= 2.3.1.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    rubyzip (1.2.0)
-    selenium-webdriver (2.53.4)
-      childprocess (~> 0.5)
-      rubyzip (~> 1.0)
-      websocket (~> 1.0)
-    semver (1.0.1)
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    sinatra (1.4.7)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    thread_safe (0.3.5)
-    tilt (2.0.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.1.0)
-    watir-webdriver (0.9.1)
-      selenium-webdriver (>= 2.46.2)
-    websocket (1.2.3)
-    websocket-driver (0.6.4)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-debug-ide (0.7.2)
+      rake (>= 0.8.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    rubyzip (2.3.0)
+    selenium-webdriver (3.142.7)
+      childprocess (>= 0.5, < 4.0)
+      rubyzip (>= 1.2.2)
+    semver2 (3.4.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    watir (6.19.1)
+      regexp_parser (>= 1.2, < 3)
+      selenium-webdriver (>= 3.142.7)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.2)
-    xpath (2.0.0)
-      nokogiri (~> 1.3)
-    yard (0.9.5)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 4)
-  arbre
-  capybara (>= 2.5)
-  codeclimate-test-reporter
-  github-markup (~> 1.4)
-  jeweler (~> 2.0)
+  activesupport
+  capybara (>= 3.0)
+  github-markup
+  jeweler
   poltergeist
-  pullreview-coverage
-  redcarpet (~> 3.3)
+  redcarpet
   rspec
-  rubocop (~> 0.34)
+  rubocop
+  ruby-debug-ide
   simplecov
   sinatra
-  watir-webdriver
+  watir
   yard (~> 0.8)
 
 BUNDLED WITH
-   1.11.2
+   2.1.4

data/Makefile

@@ -0,0 +1,13 @@
+.PHONY: help
+DOCKER_IMAGE = lvl-up/page-magic
+
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+build: ## build project docker image
+	docker build -t $(DOCKER_IMAGE) .
+
+test: ## Run tests
+	docker run -v $(PWD):/usr/src/app -t $(DOCKER_IMAGE) bundle exec rspec
+
+all: test

data/README.md

@@ -20,14 +20,34 @@ Well PageMagic might just be the answer!
 
 Give it a try and let us know what you think! There will undoubtedly be things that can be improved and issues that 
 we are not aware of so your feedback/pull requests are greatly appreciated!
+
+##Under the hood
+Under the hood PageMagic uses the totally brilliant [Capybara](https://github.com/teamcapybara/capybara) to benefit from its amazing cross browser support.
+ 
+PageMagic builds on top of Capybara to build resuable models for webpages and website structure.
+ 
+##What about the other PageObject frameworks out there?
+PageMagic isn't the first [PageObject](https://martinfowler.com/bliki/PageObject.html) framework to be written, indeed there are others out there that are totaly awesome e.g:
+- [PageObject](https://github.com/cheezy/page-object)
+- [SitePrism](https://github.com/natritmeyer/site_prism)
+
+Whilst these APIs are great, PageMagic goes much further in the power it provides for:
+ - [modelling pages](defining-pages) and page components 
+ - defining the [wait logic](#hooks) and [watchers](#watchers) that are required to build robust page objects that work reliably with javascript rich webpages.
+ - Supporting [page transitions](#page-mapping)
+ 
+Check it out :)
+
+ 
 # Contents
 
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Defining Pages](#defining-pages)
   - [Elements](#elements)
+    - [Singlular Results](#singular-results)
+    - [Multiple Results](#multiple-results)
     - [Interacting with elements](#interacting-with-elements)
-      -  [Multple Results](#multiple-results)
     - [Sub elements](#sub-elements)
     - [Custom elements](#custom-elements)
   - [Hooks](#hooks)
@@ -95,7 +115,12 @@ class Github
 end
 ```
 ## Elements
-Defining elements is easy. The following example defines a text field called 'search_field' that can be found using its name which is 'q'
+Defining elements is easy. Just give the:
+- element_type
+- id to refer to it by
+- selector to find it in the page
+
+The following example defines a text field called 'search_field' that can be found using its name which is 'q'
 
 ```ruby
 class Github
@@ -105,27 +130,66 @@ class Github
 end
 ```
 
-### Interacting with elements
-Elements are defined with an id which is the name of the method you will use to reference it. In the above example, 
-the text field was defined with the ide `:search_field`.
+Element types supported by PageMagic are:
+- text_field
+- button
+- link
+- checkbox
+- select_list
+- radio
+- textarea
 
-After visiting a page you are will get a `Session` object. Elements can be accessed through the session itself.
+PageMagic is very powerful and provides a number of different ways to define a page element so for more details please look at the [API](http://www.rubydoc.info/gems/page_magic/PageMagic%2FElements:element)
 
-```ruby
-page.search_field.set 'page_magic'
-```
+### Singular Results
+The element types written above are the method names you need to use in order to define elements of those types on your pages.
 
-#### Multiple Results
-Where an element has been scoped to return multple results, these will be returned in an array. 
+Using them as they are written above will tell PageMagic to expect to find only one element using the selector you supply. Finding more than one result will cause PageMagic to raise an `AmbiguousQueryException` 
+
+### Multiple Results
+Applying an 's' to the end of the element definition method name will tell PageMagic that more than one result can be returned using the given selector.
+
+results are returned in an `Array`.
 ```ruby
 class ResultsPage
   include PageMagic
-  element :results, css: '.repo-list-item'
+  elements :results, css: '.repo-list-item'
 end
 
 page.results #=> Array<Element> 
 ```
 
+
+### Interacting with elements
+```ruby
+class Github
+  include PageMagic
+  
+  text_field :search_field, name: 'q'
+end
+```
+Elements are defined with an id which is the name of the method you will use to reference it. In the above example, 
+the text field was defined with the id `:search_field`.
+
+After visiting a page you are will get a `Session` object. Elements can be accessed through the session itself.
+
+```ruby
+page.search_field.set 'page_magic'
+```
+PageMagic sits on top of [Capybara](https://github.com/teamcapybara/capybara) and ultimately returns capybara elements elements for you interact with. Interacting with the element types above is done by calling the following methods:
+
+ element     | method 
+ ---         | --- 
+ text_field  | set(String)
+ checkbox    | set(Boolean)
+ radio       | choose(String)
+ link        | click
+ text_area   | set(String)
+ select_list | select(String)
+ 
+Typically you will not need to know much about Capybara itself but there will be times when you want to interact with elements at a lower level.In this case please see Capybara's [API](http://www.rubydoc.info/github/jnicklas/capybara/Capybara/Node/Element) For more information.
+ 
+
 ### Sub Elements
 If your pages are complex you can use PageMagic to compose pages, their elements and subelements to as many levels as 
 you need to.
@@ -251,13 +315,13 @@ end
 In the above example the selector looks for an element that has a link containing text that includes that organisation.
 The example uses a named parameter and is invoked as follows.
 ```ruby
-page.results(organisation: 'Ladtech')
+page.results(organisation: 'lvlup')
 ```
 
 # Starting a session
 To start a PageMagic session simply decide what browser you want to use and pass it to PageMagic's `.session` method
 ```ruby
-session = PageMagic.session(browser: :chrome, url: 'https://www.github.com)
+session = PageMagic.session(browser: :chrome, url: 'https://www.github.com')
 ```
 
 Your session won't do much besides navigating to the given url until you have [mapped pages](#page-mapping) to it, so