crabfarm 0.6.1 → 0.6.2

data/lib/crabfarm/live/interactable.rb

@@ -1,5 +1,3 @@
-require 'crabfarm/utils/webdriver'
-
 module Crabfarm
   module Live
     module Interactable
@@ -29,19 +27,12 @@ module Crabfarm
 
       end
 
-      # Tooling
-
-      def highlight(_elements)
+      def examine(_tools=true)
         if Crabfarm.live?
-          if _elements.respond_to? :webdriver_elements
-            _elements = _elements.webdriver_elements
-          end
-
-          if _elements.is_a? String
-            _elements = Crabfarm.live.primary_driver.find_elements(css: _elements)
-          end
-
-          Utils::Webdriver.set_style _elements, "border: 3px solid yellow;"
+          Crabfarm.live.show_primary_contents if self.is_a? BaseNavigator
+          Crabfarm.live.show_content raw_document if self.is_a? BaseReducer
+          Crabfarm.live.show_selector_gadget if _tools
+          raise LiveInterrupted.new
         end
       end
 

data/lib/crabfarm/live/manager.rb

@@ -1,49 +1,37 @@
 require 'timeout'
-require 'crabfarm/utils/console'
-require 'crabfarm/utils/webdriver'
+require 'crabfarm/live/viewer'
 require 'crabfarm/support/webdriver_factory'
 require 'crabfarm/crabtrap_runner'
 
 module Crabfarm
   module Live
     class Manager
+      extend Forwardable
 
-      INJECTION_TM = 5 # seconds
+      attr_reader :primary_driver, :browser_adapter, :proxy_port
 
-      def initialize
-        @port = Utils::PortDiscovery.find_available_port
-        @driver_name = Crabfarm.config.recorder_driver
-      end
+      def_delegators :@viewer, :show_message, :show_selector_gadget
 
-      def proxy_port
-        @port
+      def initialize
+        reserve_port
       end
 
       def start
-        set_memento
-        load_primary_driver
-        primary_driver.get('https://www.crabtrap.io/welcome.html')
+        restart_crabtrap
+        load_browser_adapter
+        load_primary_driver_and_viewer
+        @viewer.welcome
       end
 
       def stop
-        stop_crabtrap
         release_primary_driver
+        release_viewer_driver
+        stop_crabtrap
       end
 
-      def primary_driver
-        @driver
-      end
-
-      def reset_driver_status
-        if Crabfarm.config.live_full_reload
-          # recreate driver if configured to do so
-          release_primary_driver
-          load_primary_driver
-        else
-          primary_driver.manage.delete_all_cookies
-        end
-
-        primary_driver.get('https://www.crabtrap.io/instructions.html')
+      def reset
+        reset_primary_driver
+        @viewer.reset
       end
 
       def block_requests
@@ -51,12 +39,25 @@ module Crabfarm
           stop_crabtrap
           return yield
         ensure
-          set_memento nil
+          restart_crabtrap nil
         end
       end
 
-      def set_memento(_memento=nil)
+      def show_file(_path)
+        block_requests { @viewer.show_file(_path) }
+      end
+
+      def show_content(_content)
+        block_requests { @viewer.show_content(_content) }
+      end
+
+      def show_primary_contents
+        unless @viewer_driver.nil?
+          @viewer.show_content(primary_driver.to_html)
+        end
+      end
 
+      def restart_crabtrap(_memento=nil)
         options = if _memento
           path = Utils::Resolve.memento_path _memento
           raise ConfigurationError.new "No memento found at #{path}" unless File.exists? path
@@ -65,103 +66,92 @@ module Crabfarm
           { mode: :pass }
         end
 
-        options.merge!({
-          port: @port,
-          virtual: File.expand_path('./assets/live-tools', Crabfarm.root)
-        })
-
         stop_crabtrap
-        @crabtrap = CrabtrapRunner.new config.crabtrap_config.merge(options)
-        @crabtrap.start
-
+        start_crabtrap options
       end
 
-      def stop_crabtrap
-        unless @crabtrap.nil?
-          @crabtrap.kill
-          @crabtrap = nil
-        else nil end
+    private
+
+      def reserve_port
+        @proxy_port = Utils::PortDiscovery.find_available_port
       end
 
-      def inject_web_tools
-        Utils::Console.trap_errors 'injecting web tools' do
-          Utils::Webdriver.inject_style primary_driver, 'https://www.crabtrap.io/selectorgadget_combined.css'
-          Utils::Webdriver.inject_style primary_driver, 'https://www.crabtrap.io/tools.css'
-          Utils::Webdriver.inject_script primary_driver, 'https://www.crabtrap.io/selectorgadget_combined.js'
-          Utils::Webdriver.inject_script primary_driver, 'https://www.crabtrap.io/tools.js'
-          Timeout::timeout(INJECTION_TM) { wait_for_injection }
-        end
+      def load_browser_adapter
+        @browser_adapter = Strategies.load(:browser, config.browser).new crabtrap_address
+        @browser_adapter.prepare_driver_services
       end
 
-      def show_dialog(_status, _title, _subtitle, _content=nil, _content_type=:text)
-        Utils::Console.trap_errors 'loading web dialog' do
-          primary_driver.execute_script(
-            "window.crabfarm.showDialog.apply(null, arguments);",
-            _status.to_s,
-            _title,
-            _subtitle,
-            _content,
-            _content_type.to_s
-          );
+      def load_primary_driver_and_viewer
+        @primary_driver = browser_adapter.build_driver :default_driver
+
+        # IDEA: improve this to allow different viewer modes
+        unless browser_adapter.headless?
+          primary_webdriver = browser_adapter.extract_webdriver @primary_driver
+          @viewer = Viewer.new primary_webdriver unless primary_webdriver.nil?
         end
-      end
 
-      def show_selector_gadget()
-        Utils::Console.trap_errors 'loading selector gadget' do
-          primary_driver.execute_script(
-            'window.crabfarm.showSelectorGadget();'
-          )
+        if @viewer.nil?
+          @viewer_driver = build_support_driver
+          @viewer = Viewer.new @viewer_driver
         end
       end
 
-      # Viewer implementation
-
-      def attach(_primary=true)
-        if _primary then primary_driver else build_driver end
+      def build_support_driver
+        case config.recorder_driver
+        when :firefox
+          Crabfarm::Support::WebdriverFactory.build_firefox_driver driver_config
+        when :chrome
+          Crabfarm::Support::WebdriverFactory.build_chrome_driver driver_config
+        else return nil end
       end
 
-      def detach(_driver)
-        if _driver != primary_driver
-          _driver.quit rescue nil
-        end
+      def reset_primary_driver
+        @browser_adapter.reset_driver @primary_driver
       end
 
-    private
+      def start_crabtrap(_options)
+        _options = _options.merge({
+          port: @proxy_port,
+          virtual: File.expand_path('./assets/live-tools', Crabfarm.root)
+        })
 
-      def load_primary_driver
-        @driver = build_driver
+        @crabtrap = CrabtrapRunner.new config.crabtrap_config.merge(_options)
+        @crabtrap.start
+      end
+
+      def stop_crabtrap
+        unless @crabtrap.nil?
+          @crabtrap.kill
+          @crabtrap = nil
+        else nil end
       end
 
       def release_primary_driver
-        unless @driver.nil?
-          @driver.quit rescue nil
-          @driver = nil
-        end
+        @browser_adapter.release_driver @primary_driver
+        @browser_adapter.cleanup_driver_services
+        @primary_driver = nil
       end
 
-      def build_driver
-        case @driver_name
-        when :firefox
-          Crabfarm::Support::WebdriverFactory.build_firefox_driver driver_config
-        when :chrome
-          Crabfarm::Support::WebdriverFactory.build_chrome_driver driver_config
-        else return nil end
+      def release_viewer_driver
+        unless @viewer_driver.nil?
+          @viewer_driver.quit rescue nil
+          @viewer_driver = nil
+          @viewer = nil
+        end
       end
 
       def driver_config
         {
-          proxy: "127.0.0.1:#{@port}"
+          proxy: crabtrap_address
         }
       end
 
-      def config
-        Crabfarm.config
+      def crabtrap_address
+        "127.0.0.1:#{@proxy_port}"
       end
 
-      def wait_for_injection
-        while primary_driver.execute_script "return (typeof window.crabfarm === 'undefined');"
-          sleep 1.0
-        end
+      def config
+        Crabfarm.config
       end
 
     end

data/lib/crabfarm/live/navigator_runner.rb

@@ -6,16 +6,6 @@ module Crabfarm
   module Live
     class NavigatorRunner
 
-      class Dsl
-        extend Forwardable
-
-        def initialize(_runner)
-          @runner = _runner
-        end
-
-        def_delegators :@runner, :use_memento, :use_params, :clear_params, :use_rspec, :navigate_to
-      end
-
       def initialize(_manager, _target)
         @manager = _manager
         @target = _target
@@ -27,10 +17,6 @@ module Crabfarm
         @dsl ||= Dsl.new self
       end
 
-      def memento
-        if @memento.nil? then memento_for(@target) else @memento end
-      end
-
       def use_memento(_memento)
         @memento = _memento
         @rspec = false
@@ -50,15 +36,6 @@ module Crabfarm
         @rspec = true
       end
 
-      def navigate_to(_navigator, _params={})
-        # TODO.
-      end
-
-      def prepare(_memento) # decorator
-        @manager.set_memento _memento
-        Context.new @manager
-      end
-
       def execute
         strategy = if @rspec
           NavigatorRunnerRSpec.new @manager, @target
@@ -66,31 +43,57 @@ module Crabfarm
           NavigatorRunnerDirect.new @manager, memento, @target, @params
         end
 
-        Factories::Context.with_decorator self do
-          strategy.execute
-        end
+        begin
+          Factories::Context.with_decorator navigator_decorator do
+            strategy.execute
+          end
 
-        strategy.show_results
+          @manager.show_primary_contents
+          strategy.show_results
+        rescue Crabfarm::LiveInterrupted
+          Utils::Console.info "Execution interrupted"
+        end
       end
 
     private
 
+      def memento
+        if @memento.nil? then memento_for(@target) else @memento end
+      end
+
       def memento_for(_class)
-        Utils::Naming.route_from_constant(_class.to_s).join(File::SEPARATOR)
+        Utils::Naming.route_from_constant(_class.to_s).join File::SEPARATOR
+      end
+
+      def navigator_decorator
+        @decorator ||= InterceptContextDecorator.new @manager
       end
 
-      def show_result
-        @manager.inject_web_tools
-        @manager.show_dialog(
-          :neutral,
-          'Navigation completed!',
-          "The page was scrapped in #{@elapsed.real} seconds",
-          @transition.document.to_json,
-          :json
-        )
-
-        Utils::Console.json_result @transition.document
-        Utils::Console.info "Completed in #{@elapsed.real} s"
+      class InterceptContextDecorator
+
+        def initialize(_manager)
+          @manager = _manager
+        end
+
+        def prepare(_memento)
+          @manager.restart_crabtrap _memento
+          inject_managed_context
+        end
+
+        def inject_managed_context
+          Context.new @manager
+        end
+
+      end
+
+      class Dsl
+        extend Forwardable
+
+        def initialize(_runner)
+          @runner = _runner
+        end
+
+        def_delegators :@runner, :use_memento, :use_params, :clear_params, :use_rspec, :navigate_to
       end
 
     end

data/lib/crabfarm/live/navigator_runner_direct.rb

@@ -21,8 +21,7 @@ module Crabfarm
       end
 
       def show_results
-        @manager.inject_web_tools
-        @manager.show_dialog(
+        @manager.show_message(
           :neutral,
           'Navigation completed!',
           "The page was scrapped in #{@elapsed.real} seconds",

data/lib/crabfarm/live/navigator_runner_rspec.rb

@@ -5,25 +5,23 @@ module Crabfarm
   module Live
     class NavigatorRunnerRSpec
 
+      attr_reader :example
+
       def initialize(_manager, _target)
         @manager = _manager
         @target = _target
       end
 
       def execute
-        @examples = Factories::Context.with_decorator self do
-          Utils::RSpecRunner.run_spec_for spec_for(@target), live: true
-        end
+        @example = Utils::RSpecRunner.run_single_spec_for spec_for(@target), :live
+        bubble_standard_errors
       end
 
       def show_results
-        @manager.inject_web_tools
-        if @examples.count == 0
+        if example.nil?
           show_empty_warning
-        elsif @examples.count == 1
-          show_example_output @examples.first
         else
-          show_example_summary @examples
+          show_example_output
         end
       end
 
@@ -37,75 +35,56 @@ module Crabfarm
       end
 
       def show_empty_warning
-        @manager.show_dialog(
+        @manager.show_message(
           :warning,
-          'No examples were found!',
-          'Make sure you have tagged some specs with live: true'
+          "No examples were found!",
+          "You will need to write at least one spec for #{@target.to_s}"
         )
 
-        Utils::Console.warning 'No examples were found!'
+        console.warning 'No examples were found!'
       end
 
-      def show_example_summary(_examples)
-        total = _examples.count
-        error = _examples.select { |e| !e.exception.nil? }.count
-        errored = (error > 0)
-
-        if error > 0
-          @manager.show_dialog(
+      def show_example_output
+        if example.exception
+          @manager.show_message(
             :error,
             'FAILED',
-            "#{error} of #{total} tests failed"
-          )
-
-          Utils::Console.error "#{total} examples, #{error} failures"
-        else
-          @manager.show_dialog(
-            :success,
-            'SUCCESS',
-            "All #{total} tests passed!"
-          )
-
-          Utils::Console.result "#{total} examples, 0 failures"
-        end
-      end
-
-      def show_example_output(_example)
-
-        handle_standard_errors _example
-
-        if _example.exception
-          @manager.show_dialog(
-            :error,
-            'FAILED',
-            _example.exception.to_s,
-            _example.metadata[:result].to_json,
+            example.exception.to_s,
+            example.metadata[:result].to_json,
             :json
           )
 
-          Utils::Console.error "1 example, 1 failure"
-          Utils::Console.error _example.exception.to_s
-          Utils::Console.json_result _example.metadata[:result]
+          console.error "Example \"#{example.full_description}\" failed (line: #{example.metadata[:line_number]})"
+          console.error example.exception.to_s
+          console.json_result example.metadata[:result]
         else
-          @manager.show_dialog(
+          @manager.show_message(
             :success,
             'SUCCESS',
-            "\"#{_example.full_description}\"",
-            _example.metadata[:result].to_json,
+            "\"#{example.full_description}\"",
+            example.metadata[:result].to_json,
             :json
           )
 
-          Utils::Console.result "1 example, 0 failures"
-          Utils::Console.json_result _example.metadata[:result]
+          console.result "Example \"#{example.full_description}\" passed (line: #{example.metadata[:line_number]})"
+          console.json_result example.metadata[:result]
         end
       end
 
-      def handle_standard_errors(_example)
-        if _example.exception and not _example.exception.is_a? ::RSpec::Expectations::ExpectationNotMetError
-          raise _example.exception
+      def bubble_standard_errors
+        if example and example.exception and not example.exception.is_a? expectation_error
+          raise example.exception
         end
       end
 
+      def expectation_error
+        ::RSpec::Expectations::ExpectationNotMetError
+      end
+
+      def console
+        Utils::Console
+      end
+
     end
   end
 end