superbara 0.7.0 → 0.8.0

data/docs-src/src/reference/assert.md

@@ -0,0 +1,48 @@
+# assert
+
+`assert` _asserts_ that the block is truthy at the given time. The first parameter is an optional failure message.
+
+```ruby
+assert 'login missing' do
+  has_text? 'Login'
+end
+```
+
+
+### Examples
+
+Check that example.com still has the same heading.
+
+```ruby
+visit 'example.com'
+
+assert 'somebody changed the text!'
+  h1 = find 'h1'
+  h1.text == 'Example Domain'
+end
+```
+
+Asserts can also be written without the message.
+
+```ruby
+assert do
+  has_text? "Something"
+end
+```
+
+Negative asserts can also be given.
+
+```ruby
+assert do
+  has_no_text? "Login"
+end
+
+# or
+assert do
+  !has_text? "Login"
+end
+```
+
+## Related
+
+ - [find](./reference/find.html)

data/docs-src/src/reference/dialogs/alert.md

@@ -0,0 +1 @@
+# Alert

data/docs-src/src/reference/dialogs/confirm.md

@@ -0,0 +1 @@
+# Confirm

data/docs-src/src/reference/dialogs/index.md

@@ -0,0 +1,5 @@
+# Dialogs
+
+- [alert](/reference/dialogs/alert.html)
+- [confirm](/reference/dialogs/confirm.html)
+- [prompt](/reference/dialogs/prompt.html)

data/docs-src/src/reference/dialogs/prompt.md

@@ -0,0 +1 @@
+# Prompt

data/docs-src/src/reference/find.md

@@ -0,0 +1,21 @@
+# find
+
+To get a single element use `find`
+
+```ruby
+title = find 'h1'
+```
+
+For multiple results use `all`
+
+```ruby
+links = all 'h1'
+```
+
+See (results)[./results.md] for complete list of methods available for the returned element or elements.
+
+## Advanced finding
+
+```ruby
+title = find 'h1', text: "Example Domain"
+```

data/docs-src/src/reference/results.md

@@ -0,0 +1,53 @@
+# Results
+
+## Single elements
+
+```ruby
+link = find 'a'
+link.text
+```
+
+```ruby
+link = find 'a'
+link.show
+```
+
+```ruby
+link = find 'a'
+link.click
+```
+
+
+## Multiple elements
+
+```ruby
+paragraphs = all 'p'
+paragraphs.show
+```
+
+```ruby
+paragraphs = all 'p'
+paragraphs.first.show
+paragraphs.second.show
+# ..
+paragraphs.tenth.show
+
+links = all 'a'
+paragraphs.last.click
+paragraphs.middle.click
+paragraphs.random.click
+
+
+# first
+paragraphs[0].show
+paragraphs[1].show
+# ..
+paragraphs[999].show
+
+```
+
+```ruby
+link = all 'a'
+link.click
+```
+

data/docs-src/src/reference/tests/has_text.md

@@ -0,0 +1,24 @@
+# has_text?
+
+Checks if the text is found on the screen.
+
+```ruby
+assert do
+  has_text? "Welcome"
+end
+```
+
+# Examples
+
+```ruby
+if has_text? "Logged in"
+  click_link "Log out"
+
+  wait 3 do
+    has_text? "You have logged out"
+  end
+else
+  click_link "Next"
+end
+```
+

data/docs-src/src/reference/tests/index.md

@@ -0,0 +1 @@
+# Tests

data/docs-src/src/reference/wait.md

@@ -0,0 +1,33 @@
+# wait
+
+`wait` checks every 0.1s for the block to return `true` or "anything but false" until `max_seconds` has elapsed. Quits the script with an error if the wait condition is not satisfied.
+
+```ruby
+wait max_seconds do
+  # true or anything but false
+end
+```
+
+
+### Examples
+
+Wait maximum of 3 seconds for the text 'Example Domain' to appear on the page.
+
+```ruby
+visit 'example.com'
+
+wait 3 do
+  has_text? 'Example Domain'
+end
+```
+
+Wait up to 3.3 seconds for a `<div id='login'>` to appear and assign it to a variable for clicking.
+
+```ruby
+login = wait 3.3 do
+  find 'div#login'
+end
+
+login.click
+```
+

data/docs-src/src/reference.md

@@ -0,0 +1,2 @@
+# Language Reference
+

data/docs-src/src/superbara.md

@@ -0,0 +1,7 @@
+# Superbara
+
+Superbara consists of two things:
+
+- Superbara CLI - Command Line Interface for devoloping and running tests with all batteries included and preconfigured
+- Superbara DSL - Domain Specific Language for writing tests
+

data/lib/capybara_monkey.rb

@@ -3,12 +3,8 @@ module Superbara
     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})"
+            Capybara.execute_script "scrollTo(#{self.native.location.x}, #{self.native.location.y-200})"
             styles = [
                 {
                   "border" =>  "20px dashed Aqua"
@@ -24,6 +20,11 @@ module Superbara
 
             self
           end
+
+          def type(*inputs)
+            self.native.type(*inputs)
+          end
+
         end #Includes
 
         module Prepends
@@ -125,6 +126,10 @@ module Capybara
       #warn "including Capybara::DSL in the global scope is not recommended!" if base == Object
       #super
     end
+    def self.extended(base)
+      #warn "extending the main object with Capybara::DSL is not recommended!" if base == Object
+      #super
+    end
   end
 
   module Node

data/lib/selenium_monkey.rb

@@ -4,23 +4,8 @@ module Superbara
       class Element
         module Includes
           def type(*inputs)
-            def natural_delay
-              sleep (rand(32) * 0.01).round(2)
-            end
-
-            for input in inputs
-              case input
-              when String
-                input.split("").each do |c|
-                  natural_delay
-                  self.send_keys c
-                end
-              when Symbol
-                natural_delay
-                self.send_keys input
-              end
-            end
-            true
+            self.click
+            Superbara::Helpers.type *inputs, element: self
           end
 
           def show(opts={})

data/lib/superbara/cli.rb

@@ -1,5 +1,6 @@
 module Superbara; module CLI
   def self.run!
+    require 'superbara/dsl'
     main_command = ARGV[0]
 
     case main_command
@@ -97,12 +98,12 @@ scroll 50
         exit 1
       end
     end
-
+    Pry.start if ENV['SUPERBARA_DEBUG']
     ctx = nil
     webapp_thread = nil
     puts "== superbara #{Superbara::VERSION} =="
     loop do
-      Superbara.current_context = Superbara::Context.new(shell: (main_command == "shell"))
+      Superbara.current_context = Superbara::Context.new
 
       begin
         case main_command
@@ -121,9 +122,12 @@ scroll 50
               webapp.run!
             end
           end
-
+          # to make debugger work (TODO)
+          extend Capybara::DSL
+          extend Superbara::DSL
           Superbara.current_context.__superbara_eval "visit 'localhost:4567'"
-          Superbara.current_context.__superbara_debug
+          Superbara.current_context.__superbara_debug # <-- ONLY WORKS WITH THIS??? TODO
+          exit 0
         when "run", "start"
           puts "project: #{Superbara.project_name}"
           puts ""
@@ -138,8 +142,7 @@ scroll 50
             Superbara.visual_enable!
           end
 
-          Superbara.current_context.__superbara_load(File.join(Superbara.project_path, project_entrypoint))
-
+          Superbara.current_context.__superbara_load File.join(Superbara.project_path, project_entrypoint)
           puts """
   🏁 🏁 🏁 done."""
 
@@ -147,7 +150,10 @@ scroll 50
           when "run"
             exit 0
           when "start"
-            Superbara.current_context.__superbara_debug
+            Superbara.current_context.__superbara_eval """
+debug disable_whereami: true, help: false;
+sleep 0.0001
+            """
           end
         else
           puts "Unknown command: #{main_command}"
@@ -172,7 +178,9 @@ in #{offending_file_path}:#{offending_line}
 
         case main_command
         when "start"
-          Superbara.current_context.__superbara_debug
+          Superbara.current_context.instance_eval  """debug disable_whereami: true, help: false
+sleep 0.001
+"""
         else
           exit 1
         end

data/lib/superbara/context.rb

@@ -1,11 +1,10 @@
 module Superbara; class Context
+  require_relative "dsl"
+  include Capybara::DSL
+  include Superbara::DSL
 
-  def initialize(shell: false)
-    @__superbara_shell = shell
+  def initialize
     @__superbara_binding = binding
-    @__superbara_binding.eval """
-require 'superbara/dsl'
-"""
   end
 
   def __superbara_debug
@@ -16,7 +15,7 @@ sleep 0.0001
   end
 
   def __superbara_load(path)
-    load path
+    load path, true
   end
 
   def __superbara_eval(str)

data/lib/superbara/dsl.rb

@@ -1,6 +1,10 @@
 module Superbara; module DSL
   def self.included(includer)
-    #"Superbara::DSL included in #{includer.inspect}"
+    #puts "Superbara::DSL included in #{includer.inspect}"
+  end
+
+  def type(*inputs)
+    Superbara::Helpers.type *inputs
   end
 
   def assert(message=nil, &block)
@@ -21,18 +25,31 @@ module Superbara; module DSL
     exit 1
   end
 
+  def screenshot(name=nil)
+    name = "#{Time.now.year}-#{Time.now.month}-#{Time.now.day}-#{Time.now.hour}-#{Time.now.min}-#{Time.now.sec}" unless name
+
+    filename = if name.end_with? ".png"
+      name
+    else
+      "#{name}.png"
+    end
+
+    target_path = File.join(Superbara.project_path, filename)
+    save_screenshot(target_path)
+  end
+
   def back
-    Superbara.toast("back", duration: 0.7, delay: 0.7)
+    Superbara.toast "back", duration: 0.7, delay: 0
     Capybara.go_back
   end
 
   def forward
-    Superbara.toast("forward", duration: 0.7, delay: 0.7)
+    Superbara.toast "forward", duration: 0.7, delay: 0
     Capybara.go_forward
   end
 
   def reload
-    Superbara.toast("reload", duration: 0.7, delay: 0.7)
+    Superbara.toast "reload", duration: 0.7, delay: 0
     Capybara.refresh
   end
 
@@ -115,7 +132,7 @@ return Array.from(
     end
 
     Superbara.output "visit #{url_for_capybara}"
-    Superbara.toast("#{url_for_capybara}", delay: 1) if Superbara.visual?
+    Superbara.toast "#{url_for_capybara}", delay: 1 if Superbara.visual?
 
     Capybara.visit url_for_capybara
     true # capybara returns nil
@@ -172,6 +189,7 @@ return Array.from(
 
       Superbara.output "  #{word.colorize(color)} (took #{(took_delta)}s)"
     end
+
     seconds = seconds.to_f
     source_path, source_line = block.source_location
 
@@ -291,6 +309,5 @@ return Array.from(
   end
 end; end
 
-include Capybara::DSL
-include Superbara::DSL  # override Capybara methods
-
+extend Capybara::DSL
+extend Superbara::DSL  # override Capybara methods

data/lib/superbara/helpers.rb

@@ -1,4 +1,27 @@
 module Superbara; module Helpers
+  def self.type(*inputs, element:nil)
+    for input in inputs
+      case input
+      when String
+        if input == "" && element
+          element.clear
+        else
+          input.split("").each do |c|
+            Superbara.human_typing_delay
+            Capybara.page.driver.browser.action.send_keys(c).perform
+          end
+        end
+      when Symbol
+        Superbara.human_typing_delay
+        Capybara.page.driver.browser.action.send_keys(input).perform
+      end
+
+      sleep 0.5 # without this events might not get sent properly
+    end
+
+    true
+  end
+
   def self.highlight_element(elem, styles={}, remove_highlight=0.1)
     remove_highlight_millis = (1000 * remove_highlight).round
 
@@ -49,7 +72,7 @@ window.setTimeout(function() {
       js_builder
     end
 
-    execute_script js
+    Capybara.execute_script js
     sleep remove_highlight
   end
 end; end

data/lib/superbara/version.rb

@@ -1,3 +1,3 @@
 module Superbara
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/superbara.rb

@@ -19,6 +19,7 @@ module Superbara
   @@current_context = nil
   @@visual = false
   @@started_at = Time.now
+  @@project_path = Dir.pwd
 
   def self.start!
     @@started_at = Time.now
@@ -105,6 +106,11 @@ module Superbara
     File.join(File.dirname(__FILE__), "..")
   end
 
+  def self.human_typing_delay
+    return unless ENV["SUPERBARA_HUMANIZE"]
+    sleep (rand(32) * 0.01).round(2)
+  end
+
   def self.platform
     require 'rbconfig'
     cfg = RbConfig::CONFIG
@@ -126,7 +132,7 @@ module Superbara
     end
   end
 
-  def self.toast(text, duration: 1, delay: 0)
+  def self.toast(text, duration: 1, delay: nil)
     return unless Superbara.visual?
 
     duration_millis = (duration * 1000).floor
@@ -177,7 +183,11 @@ setTimeout(function() {
 }, #{duration_millis});
 """
     Capybara.current_session.current_window.session.execute_script js
-    sleep delay
+    if delay
+      sleep delay
+    else
+      sleep duration
+    end
   end
 end
 

data/superbara.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'selenium-webdriver', '~> 3.12', '>= 3.12.0'
   spec.add_dependency 'faker', '~> 1.8', '>= 1.8.7'
   spec.add_dependency 'sinatra', '~> 2.0', '>= 2.0.1'
+
   spec.add_development_dependency 'bundler', '~> 1.15', '>= 1.15.0'
   spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0.0'
   spec.add_development_dependency 'rspec', '~> 3.7', '>= 3.7.0'

data/tests/features/screenshot.rb

@@ -0,0 +1,30 @@
+run "../common"
+
+def test_file_path(name="test")
+  File.join(Superbara.project_path, "#{name}.png")
+end
+
+def cleanup(files)
+  for path in files
+    File.unlink path if File.exist? path
+  end
+end
+
+cleanup [test_file_path]
+screenshot "test"
+
+assert "#{test_file_path} not found" do
+  File.exist? test_file_path
+end
+
+
+png_files = Dir.glob(File.join(File.dirname(__FILE__), "*.png"))
+cleanup png_files
+
+screenshot
+
+png_files = Dir.glob(File.join(File.dirname(__FILE__), "*.png"))
+assert "did not find screenshot" do
+  png_files.any?
+end
+cleanup png_files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superbara
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matti Paksula
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -257,6 +257,58 @@ files:
 - docker-compose.build.yml
 - docker-compose.test.yml
 - docker-compose.yml
+- docs-src/book.toml
+- docs-src/src/SUMMARY.md
+- docs-src/src/getting_started/index.md
+- docs-src/src/getting_started/shell.png
+- docs-src/src/install.md
+- docs-src/src/reference.md
+- docs-src/src/reference/assert.md
+- docs-src/src/reference/dialogs/alert.md
+- docs-src/src/reference/dialogs/confirm.md
+- docs-src/src/reference/dialogs/index.md
+- docs-src/src/reference/dialogs/prompt.md
+- docs-src/src/reference/find.md
+- docs-src/src/reference/results.md
+- docs-src/src/reference/tests/has_text.md
+- docs-src/src/reference/tests/index.md
+- docs-src/src/reference/wait.md
+- docs-src/src/superbara.md
+- docs/_FontAwesome/css/font-awesome.css
+- docs/_FontAwesome/fonts/FontAwesome.ttf
+- docs/_FontAwesome/fonts/fontawesome-webfont.eot
+- docs/_FontAwesome/fonts/fontawesome-webfont.svg
+- docs/_FontAwesome/fonts/fontawesome-webfont.ttf
+- docs/_FontAwesome/fonts/fontawesome-webfont.woff
+- docs/_FontAwesome/fonts/fontawesome-webfont.woff2
+- docs/ayu-highlight.css
+- docs/book.css
+- docs/book.js
+- docs/clipboard.min.js
+- docs/elasticlunr.min.js
+- docs/favicon.png
+- docs/getting_started/index.html
+- docs/getting_started/shell.png
+- docs/highlight.css
+- docs/highlight.js
+- docs/index.html
+- docs/install.html
+- docs/mark.min.js
+- docs/print.html
+- docs/reference.html
+- docs/reference/assert.html
+- docs/reference/dialogs/alert.html
+- docs/reference/dialogs/confirm.html
+- docs/reference/dialogs/index.html
+- docs/reference/dialogs/prompt.html
+- docs/reference/find.html
+- docs/reference/tests/has_text.html
+- docs/reference/tests/index.html
+- docs/reference/wait.html
+- docs/searcher.js
+- docs/searchindex.js
+- docs/superbara.html
+- docs/tomorrow-night.css
 - exe/superbara
 - lib/capybara_monkey.rb
 - lib/pry_monkey.rb
@@ -280,6 +332,7 @@ files:
 - tests/features/find.rb
 - tests/features/navigate.rb
 - tests/features/prompt.rb
+- tests/features/screenshot.rb
 - tests/features/type.rb
 - tests/features/wait.rb
 - tests/minimal/main.rb