superbara 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb221cfedb0e07f9fd5dcb495a3574653c7330824a130f2c1a7812bf3184f0b
-  data.tar.gz: 85c887a88c3183cd0a7b64fea61158d2717c6fbacb705d8e356337e15c723187
+  metadata.gz: 4d3ed6c4088db72ad7e50b5add522ca21e0e047da90c19805fd0e644b37ed174
+  data.tar.gz: de565273eae1360e53eeca61cf61821f3dfb353e863a5b6551c3522ccde3b041
 SHA512:
-  metadata.gz: 7bdc13ea9845d3a51f9a98e2853b36b4e54584050cd02b6224acebe066d03100a45b933b1c42949f207463e05459d13e2c724e0e51e79b069a11b1a677755633
-  data.tar.gz: 7e3510fb2f53a7cfce94fc019ac44f1ba260375289c1dd4da6227c5d3ac1623a4e1120e701a07f6484cb5665a15666e62f0ba68b174f8157c1759d2694f031be
+  metadata.gz: b09ae0bb806790c3090f495fa66502ee80cf9505b68379caaed1d52418a3a5016ac1074cda88b5ac5fa3006c469158e6ecff42c34d465e9b35df88d82b4e1677
+  data.tar.gz: 1597e47aecfab3de8c46deb32bc0bf1800ae8cb0cada1a1ffdc3928cd7bede4743fc80ed395cc6ebccbe51016b823f2f09e8f0b6908e46190929b3401a65c4f3

data/.kung/build/hooks/post-build

@@ -1,9 +1,2 @@
-export KUNG_FRONTEND=noninteractive KUNG_ENV=test
-kung rc chrome
-kung rc superbara
-kung stop chrome superbara
-
-kung rc chrome
-export CHROME_URL=http://localhost:14444/wd/hub
-echo q | exe/superbara run e2e
-kung stop
+KUNG_ENV=test KUNG_FRONTEND=noninteractive kung rc chrome
+KUNG_ENV=test kung rc superbara

data/Dockerfile

@@ -3,5 +3,4 @@ ARG version
 COPY superbara-${version}.gem /tmp
 RUN gem install /tmp/superbara-${version}.gem && rm /tmp/superbara-${version}.gem
 
-WORKDIR /tests
-ENTRYPOINT ["/usr/local/bundle/bin/superbara", "run"]
+ENTRYPOINT ["/usr/local/bundle/bin/superbara", "run", "/e2e"]

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    superbara (0.4.1)
+    superbara (0.5.0)
       binding_of_caller (~> 0.8, >= 0.8.0)
-      capybara (~> 3.0, >= 3.0.0)
+      capybara (~> 3.1, >= 3.1.0)
       chromedriver-helper (~> 1.2.0, >= 1.2.0)
       colorize (~> 0.8, >= 0.8.1)
+      faker (~> 1.8, >= 1.8.7)
       pry-byebug (~> 3.6, >= 3.6.0)
-      selenium-webdriver (~> 3.11, >= 3.11.0)
+      selenium-webdriver (~> 3.12, >= 3.12.0)
+      sinatra (~> 2.0, >= 2.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -19,7 +21,7 @@ GEM
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
     byebug (10.0.2)
-    capybara (3.0.0)
+    capybara (3.1.0)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
@@ -33,13 +35,19 @@ GEM
       nokogiri (~> 1.8)
     coderay (1.1.2)
     colorize (0.8.1)
+    concurrent-ruby (1.0.5)
     debug_inspector (0.0.3)
     diff-lcs (1.3)
+    faker (1.8.7)
+      i18n (>= 0.7)
     ffi (1.9.23)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
     io-like (0.3.0)
     method_source (0.9.0)
     mini_mime (1.0.0)
     mini_portile2 (2.3.0)
+    mustermann (1.0.2)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     pry (0.11.3)
@@ -49,7 +57,9 @@ GEM
       byebug (~> 10.0)
       pry (~> 0.10)
     public_suffix (3.0.2)
-    rack (2.0.4)
+    rack (2.0.5)
+    rack-protection (2.0.1)
+      rack
     rack-test (1.0.0)
       rack (>= 1.0, < 3)
     rake (10.5.0)
@@ -67,9 +77,15 @@ GEM
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
     rubyzip (1.2.1)
-    selenium-webdriver (3.11.0)
+    selenium-webdriver (3.12.0)
       childprocess (~> 0.5)
       rubyzip (~> 1.2)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    tilt (2.0.8)
     xpath (3.0.0)
       nokogiri (~> 1.8)
 

data/README.md

@@ -1,22 +1,182 @@
 # Superbara
 
+Web app test scripting that does not hurt.
+
+ - Based on Capybara: everything is just better and more natural
+ - All batteries included: just start scripting, nothing extra required
+ - A powerful command line interface with interactive debugger
+ - The most natural test language that is still programming, see:
+
+```ruby
+visit "mysite.com"
+wait 3 do
+  has_text? "welcome"
+end
+
+scroll 20
+click_link "enter"
+
+name_field = find "input#name"
+name_field.type "Sarah", :enter
+
+if has_text? "Welcome, Sarah"
+  run "logout"
+else
+  fail "no greeting visible"
+end
 ```
+
+## Install & Usage
+
+```shell
 gem install superbara
-mkdir tests
-cd tests
 superbara init example
 superbara start example
+superbara usage
+```
+
+## Some things that Superbara does that Capybara does not:
+
+```ruby
+# find+click in one line!
+click 'h1'
+
+# wait up to 3 seconds for block to return something else than nil or false
+wait 3 do
+  has_text? "Welcome"
+end
+
+wait 3.1 do
+  find "#username"
+end
+
+# simulates real typing
+textarea = find "textarea"
+textarea.type "hello", :backspace, :backspace, :backspace, "sinki", :enter
+
+# scrolling
+scroll 50
+scroll -20, duration: 4
+
+# works also without http://
+visit 'example.com'
+
+# highlights when in interactive mode or SUPERBARA_VISUAL env is set
+find "h1"
+
+# runs project/file.rb
+run "vars"
+
+# possible to run just once per session (superbara start) to speed up
+run "login", once: true
+
+# ..and do something when already ran
+run "login", once: true do
+  # when already logged in
+  visit "http://www.example.com/main"
+end
+
+# opens debugger when exception happens or when the test finishes or
+debug
+
+# back, forward, reload (and not only go_back, go_forward, refresh)
+back
+forward
+reload
+
+# natural sleeps, sleep between 2 and 4 seconds
+think 2..4
+```
+
+Everything that works in Capybara, works in Superbara, see https://github.com/teamcapybara/capybara/#the-dsl
+
+Quick Reference:
 ```
+click_link 'id-of-link'
+click_link 'Link Text'
+click_button 'Save'
+click_on 'Link Text' || click_on 'Button Value'
+click_text 'get started'
+
+find 'h1'
+find_field('First Name').value
+find_field(id: 'my_field').value
+find_link('Hello', :visible => :all).visible?
+find_link(class: ['some_class', 'some_other_class'], visible: :all).visible?
+
+find_button('Send').click
+find_button(value: '1234').click
+
+find(:xpath, ".//table/tr").click
+find("#overlay").find("h1").click
+for a in all('a') do
+  if a[:href].include? "about"
+    a.click
+  end
+end
+
+img_boxed = find('img') do |el|
+  el['data-box'] == true
+end
+
+within '#menu' do
+  click 'a', text: 'Pricing'
+end
+
+within_table 'Employee' do
+  fill_in 'Name', with: 'Sarah'
+end
+
+within_fieldset 'Employee' do
+  ...
+end
+
+facebook_window = window_opened_by do
+  click_button 'Like'
+end
+
+within_window facebook_window do
+  find('#login_email').type 'a@example.com'
+  find('#login_password').type 'qwerty'
+  click_button 'Submit'
+end
+
+execute_script "document.querySelector("#name").style.border = '1px solid red';"
+
+value = evaluate_script "window.innerHeight"
+
+accept_alert do
+  click_link 'Show Alert'
+end
+
+dismiss_confirm do
+  click_link 'Show Confirm'
+end
 
+message = accept_prompt with: 'Linda Liukas' do
+  click_link 'Author Quiz!'
+end
+message = 'Who is the author of Hello Ruby?'
 
-## Deps
+has_selector? 'table tr'
+has_no_selector? 'table tr'
 
-https://github.com/SeleniumHQ/selenium/blob/master/rb/CHANGES
-https://github.com/teamcapybara/capybara/blob/master/History.md
+has_selector? :xpath, './/table/tr'
 
+has_xpath? './/table/tr'
+has_no_xpath? './/table/tr'
+has_css? 'table tr.foo'
+has_no_css? 'table tr.foo'
 
-## Releasing
+has_content? 'foo'
+has_no_content? 'foo'
+has_text? 'foo'
+has_no_text? 'foo'
 
+fill_in 'First Name', with: 'Johwn'
+choose 'A Radio Button'
+check 'A Checkbox'
+uncheck 'A Checkbox'
+attach_file 'Image', File.join(Dir.pwd,'image.jpg')
+select 'Option', from: 'Select Box'
 ```
-$ rake release
-```

data/bin/console

@@ -5,7 +5,6 @@ require_relative "../lib/superbara"
 require_relative "../lib/superbara/dsl"
 
 visit "http://www.example.com"
-h1 = find "h1"
-h1.highlight
+find "h1"
 
 Pry.start

data/docker-compose.test.yml

@@ -3,11 +3,11 @@ version: '3.6'
 services:
   superbara:
     image: mattipaksula/superbara
-    command: e2e
     environment:
       - SUPERBARA_FRONTEND=noninteractive
+      - CHROME_URL=http://chrome:4444/wd/hub
     volumes:
-      - ./e2e:/tests/e2e
+      - ./e2e:/e2e
     depends_on:
       - chrome
   chrome:

data/e2e/example.rb

@@ -0,0 +1,7 @@
+wait 5 do
+  visit "example.com"
+end
+
+wait 5 do
+  has_text? "Example Domain"
+end

data/e2e/init.rb

@@ -0,0 +1,2 @@
+webapp = Superbara::Web.new access_log: false, server_bind: '0.0.0.0'
+webapp.run_async!

data/e2e/main.rb

@@ -1,8 +1,17 @@
-if ENV["CHROME_URL"]
-  Capybara.default_driver = :chrome_remote
+run "init", once: true
+run "vars"
+
+visit "#{$test_host}:4567"
+wait "3" do
+  has_text? "Superbara"
 end
 
-visit "http://www.example.com"
+run "wait"
+run "prompt"
+run "type"
+
+run "example", once: true do
+  visit "example.com"
+end
 
-h1 = find "h1"
-h1.highlight
+find "h1"

data/e2e/prompt.rb

@@ -0,0 +1,7 @@
+visit "/__superbara/prompt"
+
+message = accept_prompt with: 'Linda Liukas' do
+  click_link 'Author Quiz!'
+end
+
+fail unless message == 'Who is the author of Hello Ruby?'

data/e2e/type.rb

@@ -0,0 +1,4 @@
+visit "/"
+
+textarea = find "textarea"
+textarea.type "hello", :backspace, :backspace, "sinki", :enter

data/e2e/vars.rb

@@ -0,0 +1,5 @@
+$test_host = if ENV["CHROME_URL"]
+  "superbara"
+else
+  "localhost"
+end

data/e2e/wait.rb

@@ -0,0 +1,7 @@
+visit "/__superbara/wait"
+
+fail if has_text? "500ms"
+
+wait 0.8 do
+  has_text? "500ms"
+end

data/exe/superbara

@@ -1,5 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-base_path = File.dirname(File.dirname(__FILE__))
+# add lib to libpath (only needed when running from the sources)
+require 'pathname'
+lib_path = File.expand_path('../../lib', Pathname.new(__FILE__).realpath)
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
 
-Process.exec "#{base_path}/lib/supershell #{ARGV.join(' ')}"
+STDOUT.sync = true
+
+require 'superbara'
+Superbara::CLI.run!

data/lib/capybara_monkey.rb

@@ -1,49 +1,140 @@
+module Superbara
+  module CapybaraMonkey
+    module Node
+      class Element
+        module Includes
+          def type(*text)
+            self.native.type(*text)
+          end
+
+          def show(styles: nil, remove_highlight: 0.1)
+            execute_script "scrollTo(#{self.native.location.x}, #{self.native.location.y-200})"
+            styles = [
+                {
+                  "border" =>  "20px dashed Aqua"
+                }
+              ] unless styles
+
+            for style in styles
+              Superbara::Helpers.highlight_element(self, style, remove_highlight)
+              if styles.size > 1
+                sleep 0.05
+              end
+            end
+
+            self
+          end
+        end #Includes
+
+        module Prepends
+          def click(*keys, **offset)
+            if Superbara.visual?
+              sleep 0.1
+              self.show(styles: [{"border" =>  "10px dashed GreenYellow"}], remove_highlight: 0.1)
+            end
+            Superbara.output "click #{self.tag_name} '#{self.text}'"
+            super *keys, **offset
+          end
+        end
+      end #Element
+    end #Node
+
+    class Result
+      module Includes
+        def second
+          self[1]
+        end
+        def third
+          self[2]
+        end
+        def fourth
+          self[3]
+        end
+        def fifth
+          self[4]
+        end
+        # active support stops herew
+        def sixth
+          self[5]
+        end
+        def seventh
+          self[6]
+        end
+        def eight
+          self[7]
+        end
+        def ninth
+          self[8]
+        end
+        def tenth
+          self[9]
+        end
+        # also
+        def random
+          self[rand(self.size)]
+        end
+        def middle
+          self[self.size/2]
+        end
+
+        def show(styles=nil)
+          for e in self
+            e.show styles
+          end
+          self
+        end
+
+        def click_random(show: false, once: true)
+          unless self.any?
+            return false
+          end
+
+          index = if once
+            @__superbara_clicked ||= []
+            if @__superbara_clicked.size == self.size
+              return false
+            end
+
+            selected_index = nil
+            possible_index = nil
+            loop do
+              possible_index = rand(self.size)
+              next if @__superbara_clicked.include? possible_index
+              selected_index = possible_index
+              @__superbara_clicked << selected_index
+              break
+            end
+
+            selected_index
+          else
+            rand(self.size)
+          end
+
+          element = self[index]
+          element.show if show
+          element.click
+        end
+      end #Includes
+    end #Result
+  end #Capybara
+end #Superbara
+
 module Capybara
+  module DSL
+    def self.included(base)
+      #warn "including Capybara::DSL in the global scope is not recommended!" if base == Object
+      #super
+    end
+  end
+
   module Node
     class Element
-      def highlight
-        for color in ["DeepPink", "GreenYellow", "Aqua", "Red", "Yellow"]
-          Superbara::Helpers.highlight_element(self, {color: color})
-          sleep 0.1
-        end
-        "did you see it?"
-      end
+      include Superbara::CapybaraMonkey::Node::Element::Includes
+      prepend Superbara::CapybaraMonkey::Node::Element::Prepends
     end
   end
 
   class Result
-    def click_random(highlight: false, once: true)
-      unless self.any?
-        Superbara.puts "no elements in collection"
-        return false
-      end
-
-      index = if once
-        @__superbara_clicked ||= []
-        if @__superbara_clicked.size == self.size
-          Superbara.puts "no unclicked elements left, not clicking anything"
-          return false
-        end
-
-        selected_index = nil
-        possible_index = nil
-        loop do
-          possible_index = rand(self.size)
-          next if @__superbara_clicked.include? possible_index
-          selected_index = possible_index
-          @__superbara_clicked << selected_index
-          break
-        end
-
-        selected_index
-      else
-        rand(self.size)
-      end
-
-      element = self[index]
-      element.highlight if highlight
-      Superbara.puts "clicking index: #{index} out of #{self.size}"
-      element.click
-    end
+    include Superbara::CapybaraMonkey::Result::Includes
   end
 end

data/lib/pry_monkey.rb

@@ -1,21 +1,45 @@
 require "pry-byebug"
 require "binding_of_caller"
 
-class Pry
-  class Command::Whereami < Pry::ClassCommand
-    alias_method :process_orig, :process
-    def process
-      if $supress_pry_whereami
-        $supress_pry_whereami = false
-        puts ""
-        nil
-      else
-        process_orig
+module Superbara
+  module PryMonkey
+    class Command
+      class Exit < Pry::ClassCommand
+        module Prepends
+          def process
+            Superbara.shell_disable!
+            Superbara.visual_disable!
+            super
+          end
+        end
+      end
+
+      class Whereami < Pry::ClassCommand
+        module Prepends
+          def process
+            if $__superbara_supress_pry_whereami
+              $__superbara_supress_pry_whereami = false
+              puts ""
+              nil
+            else
+              super
+            end
+          end
+        end
       end
     end
   end
 end
 
+class Pry
+  class Command::Exit < Pry::ClassCommand
+    prepend ::Superbara::PryMonkey::Command::Exit::Prepends
+  end
+  class Command::Whereami < Pry::ClassCommand
+    prepend ::Superbara::PryMonkey::Command::Whereami::Prepends
+  end
+end
+
 Pry.config.prompt = proc {
   prefix = "\n==[ console ]== (".colorize(:black).on_white
 
@@ -47,27 +71,26 @@ Pry.commands.alias_command 'n', 'next'
 Pry.commands.alias_command 'h', 'help'
 
 Pry::Commands.command /^e$/, "edit" do
-  puts "Opening #{$superbara_current_file} ..."
-  begin
-    `superbara edit #{$superbara_current_file}`
-  rescue Exception => ex
-    puts "[development mode edit]"
-    `exe/superbara edit #{$superbara_current_file}`
-  end
+  puts "Opening #{Superbara.project_path} ..."
+  `superbara edit #{Superbara.project_path}`
 end
 
 Pry::Commands.command /^help$/, "help" do
-
   capybara_help_help = '''
-  e = find "h1", text: "Example Domain"
+  e = find "h1"
   e = find "h1", text: /xample Dom/
   e.click
 
   e = wait 2 do
-    find "p", text: "Added to the cart"
+    find "span", text: "Added to the cart"
   end
   e.click
 
+  think 2..4
+  scroll 50
+  scroll -10, duration: 4
+  focus
+
   more: https://github.com/teamcapybara/capybara#the-dsl'''
 
   capybara_help_header_prefix = "== HELP "
@@ -84,7 +107,7 @@ Pry::Commands.command /^q$/, "abort" do
 end
 
 Pry::Commands.command /^r$/, "retry" do
-  exit 2
+  _pry_.run_command "exit"
 end
 
 Pry::Commands.command /^$/, "repeat last command if stepping" do