superbara 0.4.1 → 0.5.0

data/lib/selenium_monkey.rb

@@ -0,0 +1,42 @@
+module Superbara
+  module SeleniumMonkey
+    module WebDriver
+      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
+          end
+
+          def show(opts={})
+            execute_script "scrollTo(#{self.location.x}, #{self.location.y-200})"
+            Superbara::Helpers.highlight_element(self)
+          end
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    class Element
+      include Superbara::SeleniumMonkey::WebDriver::Element::Includes
+    end
+  end
+end

data/lib/superbara/chrome.rb

@@ -14,12 +14,16 @@ module Superbara; module Chrome
     options.add_argument 'disable-infobars'
 
     capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-      pageLoadStrategy: @@page_load_strategy
+      pageLoadStrategy: @@page_load_strategy,
     )
 
+    client = Selenium::WebDriver::Remote::Http::Default.new
+    client.read_timeout = 10
+
     Capybara.register_driver :chrome do
       Capybara::Selenium::Driver.new(nil,
         browser: :chrome,
+        http_client: client,
         options: options,
         desired_capabilities: capabilities
       )
@@ -30,6 +34,7 @@ module Superbara; module Chrome
 
       Capybara::Selenium::Driver.new(nil,
         browser: :remote,
+        http_client: client,
         desired_capabilities: capabilities,
         url: chrome_url
       )
@@ -40,12 +45,10 @@ module Superbara; module Chrome
 
       Capybara::Selenium::Driver.new(nil,
         browser: :chrome,
+        http_client: client,
         desired_capabilities: capabilities,
         options: options
       )
     end
-
-    Superbara.puts "registered drivers"
-    Superbara.puts capabilities.inspect
   end
 end; end

data/lib/superbara/cli.rb

@@ -0,0 +1,132 @@
+module Superbara; module CLI
+  def self.run!
+    main_command = ARGV[0]
+
+    case main_command
+    when "version"
+      puts Superbara::VERSION
+      exit 0
+    when "web", "shell"
+      #
+    when "init"
+      project_name = ARGV[1]
+      unless project_name
+        puts "project name missing"
+        exit 1
+      end
+
+      if Dir.exists? project_name
+        puts "directory #{project_name} already exists"
+        exit 1
+      end
+
+      contents = """visit \"http://example.com\"
+
+wait 3 do
+  has_text? \"Example Domain\"
+end
+click \"h1\"
+think 1..3
+click \"a\"
+scroll 50
+"""
+      Dir.mkdir project_name
+      File.write File.join(project_name, "main.rb"), contents
+      exit 0
+    else
+      unless ARGV[1]
+        puts """USAGE:
+
+  superbara init <dir>    - initialize a test directory
+
+  superbara run <dir>     - run a test
+  superbara start <dir>   - run a test and start development mode
+  superbara shell         - interactive mode with built-in web server
+
+  superbara web           - start the built-in web server
+  superbara edit <dir>    - edit directory with $EDITOR
+"""
+        exit 1
+      end
+
+      project_path_expanded = File.expand_path(ARGV[1])
+
+      Superbara.project_path = if Dir.exists? project_path_expanded
+        project_path_expanded
+      else
+        puts "#{project_path_expanded} is not a directory"
+        exit 1
+      end
+    end
+
+    ctx = nil
+    webapp_thread = nil
+    puts "== superbara #{Superbara::VERSION} =="
+    loop do
+      Superbara.current_context = Superbara::Context.new(shell: (main_command == "shell"))
+
+      case main_command
+      when "web"
+        webapp = Superbara::Web.new
+        webapp.run!
+        exit 0
+      when "shell"
+        Superbara.visual_enable!
+        Superbara.shell_enable!
+        Superbara::Chrome.page_load_strategy = "none"
+
+        unless webapp_thread
+          webapp_thread = Thread.new do
+            webapp = Superbara::Web.new access_log: false
+            webapp.run!
+          end
+        end
+
+        Superbara.current_context.__superbara_eval "visit 'localhost:4567'"
+        Superbara.current_context.__superbara_debug
+      when "run", "start"
+        puts "project: #{Superbara.project_name}"
+        puts ""
+        puts "t      action".colorize(:light_black)
+        Superbara.start!
+        Superbara.visual_disable!
+        Superbara.current_context.__superbara_eval "visit 'about:blank'"
+        Superbara.visual_enable!
+
+        Superbara.current_context.__superbara_load(File.join(Superbara.project_path, "main.rb"))
+
+        puts """
+🏁 🏁 🏁 done."""
+
+        case main_command
+        when "run"
+          exit 0
+        when "start"
+          Superbara.current_context.__superbara_debug
+        end
+      else
+        puts "Unknown command: #{main_command}"
+        exit 1
+      end
+
+      rescue Exception => ex
+        return if ex.class == SystemExit
+
+        begin
+          offending_file_path_and_line_in_this = ex.backtrace.detect { |line| line.end_with?("`<top (required)>'") }
+          offending_file_path, offending_line, _ = offending_file_path_and_line_in_this.split(":")
+          offending_code = IO.readlines(offending_file_path)[offending_line.to_i-1]
+        rescue Exception => ex_while_parsing
+          raise ex
+        end
+        puts """
+== Exception ==""".colorize(:red)
+        puts """#{ex.class}
+#{ex.message}
+in #{offending_file_path}:#{offending_line}
+#{offending_line}: #{offending_code}""".colorize(:light_black)
+
+        Superbara.current_context.__superbara_debug
+    end
+  end
+end; end

data/lib/superbara/context.rb

@@ -0,0 +1,57 @@
+module Superbara; class Context
+
+  def initialize(shell: false)
+    @__superbara_shell = shell
+    @__superbara_binding = binding
+    @__superbara_binding.eval """
+require 'superbara/dsl'
+"""
+  end
+
+  def __superbara_debug
+    __superbara_eval """
+debug disable_whereami: true, help: false
+sleep 0.0001
+"""
+  end
+
+  def __superbara_load(path)
+    load path
+  end
+
+  def __superbara_eval(str)
+    @__superbara_binding.eval str
+  end
+
+  def method_missing(m, *args, &block)
+    super unless Superbara.shell?
+
+    selector = m.to_s
+    finder_args = args[0] if args.any?
+
+    would_find_size = evaluate_script "document.querySelectorAll('#{m}').length"
+    if would_find_size > 50
+      puts "tried to find with selector '#{m}', but would return over 50 elements (#{would_find_size}) and hang."
+      return false
+    end
+
+    print "finding all '#{m}'"
+
+    results = if finder_args
+      puts " #{finder_args}"
+      all selector, finder_args
+    else
+      puts ""
+      all selector
+    end
+
+    if results.size == 1
+      results.first.show
+    elsif results.size > 1
+      results.show(styles: [{"border" =>  "20px dashed Red"}])
+    else
+      []
+    end
+  end
+
+end; end

data/lib/superbara/dsl.rb

@@ -1,6 +1,102 @@
 module Superbara; module DSL
   def self.included(includer)
-    puts "Superbara::DSL included in #{includer.inspect}"
+    #"Superbara::DSL included in #{includer.inspect}"
+  end
+
+  def fail(message=nil)
+    if message
+      Superbara.output ("FAIL: ".colorize(:red) + message)
+    else
+      Superbara.output "FAIL: ".colorize(:red)
+    end
+
+    exit 1
+  end
+
+  def back
+    Superbara.toast("back", duration: 0.7, delay: 0.7)
+    Capybara.go_back
+  end
+
+  def forward
+    Superbara.toast("forward", duration: 0.7, delay: 0.7)
+    Capybara.go_forward
+  end
+
+  def reload
+    Superbara.toast("reload", duration: 0.7, delay: 0.7)
+    Capybara.refresh
+  end
+
+  def find(*args)
+    value = super *args
+    value&.show if Superbara.visual?
+    value
+  end
+
+  def find_text(text)
+    text.downcase!
+
+    js = """
+return Array.from(
+  document.querySelectorAll('*')
+).filter(function(e) {
+  return e.textContent.toLowerCase().match('#{text}') ? true : false
+}).pop()
+"""
+    element = page.execute_script js
+    element&.show if Superbara.visual?
+    element
+  end
+
+  def click_text(text)
+    find_text(text)&.click
+  end
+
+  def click(selector, options={})
+    Superbara.output "clicking '#{selector}' with #{options.inspect}"
+    e = find selector, options
+    e.click
+  end
+
+  @@once_runs = []
+  def run(what, once: false, &block)
+    if once
+      if @@once_runs.include? what
+        if block
+          value = block.call
+          return value
+        else
+          return false
+        end
+      else
+        @@once_runs << what
+      end
+    end
+
+    Superbara.output "run #{what}"
+    Superbara.toast "run #{what}" if Superbara.visual?
+
+    Superbara.current_context.__superbara_load(File.join(Superbara.project_path, "#{what}.rb"))
+  end
+
+  def visit(visit_uri_or_domain_or_path)
+    uri = ::Addressable::URI.parse(visit_uri_or_domain_or_path)
+    current_uri = ::Addressable::URI.parse(Capybara.current_url)
+
+    url_for_capybara = if visit_uri_or_domain_or_path.start_with? "/"
+      [current_uri.scheme, "://", current_uri.host, (current_uri.port ? ":#{current_uri.port}" : ""), visit_uri_or_domain_or_path].join("")
+    elsif ["http", "https", "about"].include? uri.scheme
+      visit_uri_or_domain_or_path
+    else
+      "http://#{visit_uri_or_domain_or_path}"
+    end
+
+    Superbara.output "visit #{url_for_capybara}"
+    Superbara.toast("#{url_for_capybara}", delay: 1) if Superbara.visual?
+
+    Capybara.visit url_for_capybara
+    true # capybara returns nil
   end
 
   def atleast(range)
@@ -8,11 +104,40 @@ module Superbara; module DSL
     add = rand(range.to_a.last)
     min+add
   end
+
   def think(range)
     duration = atleast(range)
 
-    Superbara.puts "thinking #{duration}s"
-    sleep duration
+    Superbara.output "think #{duration}s"
+    if Superbara.visual?
+      Superbara.toast "hmm...", delay: duration
+    else
+      sleep duration
+    end
+  end
+
+  @@focused_once = false
+  def focus(once: false)
+    if once
+      return false if @@focused_once
+      @@focused_once = true
+    end
+
+    Capybara.page.switch_to_window Capybara.current_window
+  end
+
+  def scroll(percentage, duration: 0.4)
+    outer_height = Capybara.current_session.current_window.session.execute_script "return document.body.scrollHeight"
+    scroll_y = outer_height / 100 * percentage
+
+    scrolls = (duration / 0.1).floor
+    amount = (scroll_y / scrolls).ceil
+    Superbara.output "scrolling #{percentage}%"
+    scrolls.times do
+      Capybara.current_session.current_window.session.execute_script "window.scrollBy(0,#{amount})"
+      sleep 0.09
+    end
+    true
   end
 
   def wait(seconds, &block)
@@ -23,13 +148,25 @@ module Superbara; module DSL
         ["FAIL", :red]
       end
 
-      puts "#{word.colorize(color)} (took #{(took_delta)}s)"
+      Superbara.output "  #{word.colorize(color)} (took #{(took_delta)}s)"
     end
     seconds = seconds.to_f
+    source_path, source_line = block.source_location
 
-    print "--> waiting max #{seconds}s "
-    started_at = Time.now
+    Superbara.output "waiting max #{seconds}s for:"
+    case source_path
+    when "(pry)"
+      Superbara.output "    [dynamic code]".colorize(:light_black)
+    else
+      open(source_path).each_with_index do |line, i|
+        next if i < source_line
+        break if line.start_with? "end"
+        formatted_line = line.gsub("\n", "").lstrip
+        Superbara.output "  #{formatted_line}".colorize(:light_black)
+      end
+    end
 
+    started_at = Time.now
     previous_capybara_default_max_wait_time = Capybara.default_max_wait_time
     block_value = nil
     exception = nil
@@ -37,7 +174,15 @@ module Superbara; module DSL
     begin
       Capybara.default_max_wait_time = seconds
       Timeout::timeout (seconds+0.1) do
-        block_value = block.call
+        loop do
+          block_value = block.call
+          case block_value
+          when false, nil
+            sleep 0.1
+          else
+            break
+          end
+        end
       end
     rescue Timeout::Error => ex
       timed_out = true
@@ -54,13 +199,19 @@ module Superbara; module DSL
       additional_started_at = Time.now
       additional_block_value = nil
       additional_exception = nil
+      previous_default_max_wait_time = Capybara.default_max_wait_time
       puts "  testing if waiting for 2 seconds more would help.."
       begin
-        Capybara.default_max_wait_time = 2
-        additional_block_value = block.call
+        Timeout::timeout(2.1) do
+          Capybara.default_max_wait_time = 2
+          additional_block_value = block.call
+        end
       rescue Exception => ex
         additional_exception = ex
+      ensure
+        Capybara.default_max_wait_time = previous_default_max_wait_time
       end
+
       additional_took_delta = (Time.now - additional_started_at).floor(2)
       suggested_wait_value = (seconds + additional_took_delta).floor(2)
 
@@ -91,8 +242,11 @@ module Superbara; module DSL
     return block_value
   end
 
-  def debug(exception_occurred:false)
+  def debug(exception_occurred:false, disable_whereami: false, help: true)
     return if ENV['SUPERBARA_FRONTEND'] == "noninteractive"
+    Superbara.shell_enable!
+    Superbara.visual_enable!
+
     debug_help = """
     c - continue to the next debug breakpoint
     s - step to the next line
@@ -103,15 +257,18 @@ module Superbara; module DSL
     debug_header_prefix = "== DEBUG "
     debug_header_suffix = "=" * (IO.console.winsize.last - debug_header_prefix.size)
 
-    puts """
+    if help
+      puts """
 #{debug_header_prefix}#{debug_header_suffix}
 #{debug_help}
 """.colorize(:light_green)
+    end
 
-    $supress_pry_whereami = true if exception_occurred
+    $__superbara_supress_pry_whereami = true if exception_occurred || disable_whereami
     Pry.start(binding.of_caller(1))
   end
 end; end
 
-include Superbara::DSL
 include Capybara::DSL
+include Superbara::DSL  # override Capybara methods
+

data/lib/superbara/helpers.rb

@@ -1,7 +1,26 @@
 module Superbara; module Helpers
-  def self.highlight_element(elem, styles={}, remove_highlight=100)
-    # Yes, could have used a template here.
-    js = """
+  def self.highlight_element(elem, styles={}, remove_highlight=0.1)
+    remove_highlight_millis = (1000 * remove_highlight).round
+
+    js = if elem.class == Selenium::WebDriver::Element
+      """
+var __superbaraShowElem = document.createElement('p');
+__superbaraShowElem.style.position = 'fixed';
+__superbaraShowElem.style.top = '#{elem.location.y-10}px';
+__superbaraShowElem.style.left = '#{elem.location.x}px';
+__superbaraShowElem.style.color = 'white';
+__superbaraShowElem.style.backgroundColor = 'red';
+__superbaraShowElem.style.zIndex = '99999999999';
+__superbaraShowElem.textContent = 'XXXXX';
+
+window.document.body.appendChild(__superbaraShowElem);
+
+window.setInterval(function() {
+  __superbaraShowElem.remove();
+}, #{remove_highlight_millis});
+"""
+    else
+      js_builder = """
 window.__superbara = {};
 __superbara.getElementByXpath = function(path) {
 return document.evaluate(path, document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
@@ -9,25 +28,28 @@ return document.evaluate(path, document, null, XPathResult.FIRST_ORDERED_NODE_TY
 window.__superbara.highlightElem = window.__superbara.getElementByXpath('#{elem.path}');
 window.__superbara.highlightElem.oldStyle = {};
 """
-    styles.each_pair do |k,v|
-      js << """window.__superbara.highlightElem.oldStyle.#{k} = window.__superbara.highlightElem.style.#{k};
+      styles.each_pair do |k,v|
+        js_builder << """window.__superbara.highlightElem.oldStyle.#{k} = window.__superbara.highlightElem.style.#{k};
 window.__superbara.highlightElem.style.#{k} = '#{v}'
 """
-    end
+      end
 
-    js << """
+      js_builder << """
 window.setTimeout(function() {
   var e = window.__superbara.getElementByXpath('#{elem.path}');
 """
-    styles.each_pair do |k,v|
-      js << """e.style.#{k} = e.oldStyle.#{k};
+      styles.each_pair do |k,v|
+        js_builder << """e.style.#{k} = e.oldStyle.#{k};
 """
-    end
+      end
 
-    js << """
-}, #{remove_highlight})
+      js_builder << """
+}, #{remove_highlight_millis})
 """
-    Capybara.current_session.current_window.session.execute_script js
-  end
+      js_builder
+    end
 
+    execute_script js
+    sleep remove_highlight
+  end
 end; end

data/lib/superbara/rspec.rb

@@ -9,7 +9,8 @@ RSpec.configure do |config|
   config.fail_fast = true
 
   config.before(:each) do |example|
-    $superbara_current_file = example.metadata[:example_group][:file_path]
+    #TODO
+    #$superbara_current_file = example.metadata[:example_group][:file_path]
 
     puts ""
     class_path = example.example_group_instance.class.to_s.split("::")
@@ -31,4 +32,4 @@ RSpec.configure do |config|
       debug(exception_occurred: true)
     end
   end
-end
+end

data/lib/superbara/version.rb

@@ -1,3 +1,3 @@
 module Superbara
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/superbara/web.rb

@@ -0,0 +1,34 @@
+require 'sinatra/base'
+
+module Superbara; class Web
+  def initialize(access_log: true, server_bind: '127.0.0.1')
+    @webapp = Sinatra.new do
+      root_path = File.join(File.dirname(__FILE__), "..", "..", "web")
+
+      unless access_log
+        set :server_settings, :AccessLog=>[]
+      end
+
+      set :bind, server_bind
+      set :root, root_path
+
+      get '/' do
+        File.read(File.join(root_path,"public", "index.html"))
+      end
+
+      get '/__superbara/:feature' do
+        erb params[:feature].to_sym
+      end
+    end
+  end
+
+  def run!
+    @webapp.run!
+  end
+
+  def run_async!
+    Thread.new do
+      self.run!
+    end
+  end
+end; end