crabfarm 0.4.2 → 0.5.1

data/lib/crabfarm/live/reducer_runner_direct.rb

@@ -0,0 +1,41 @@
+require 'benchmark'
+require 'crabfarm/utils/console'
+
+module Crabfarm
+  module Live
+    class ReducerRunnerDirect
+
+      def initialize(_manager, _snapshot, _target, _params)
+        @manager = _manager
+        @snapshot = _snapshot
+        @target = _target
+        @params = _params
+      end
+
+      def execute
+        raise ArgumentError.new 'Must provide a snapshot to execute reducer' if @snapshot.nil?
+
+        snapshot_path = @target.snapshot_path @snapshot
+        raise ArgumentError.new "Snapshot does not exist #{snapshot_path}" unless File.exist? snapshot_path
+
+        @reducer = Factories::SnapshotReducer.build @target, snapshot_path, (@params || {})
+        @elapsed = Benchmark.measure { @reducer.run }
+      end
+
+      def show_results
+        @manager.inject_web_tools
+        @manager.show_dialog(
+          :neutral,
+          'Reducing completed!',
+          "The page was parsed in #{@elapsed.real} seconds",
+          @reducer.to_json,
+          :json
+        )
+
+        Utils::Console.json_result @reducer
+        Utils::Console.info "Completed in #{@elapsed.real} s"
+      end
+
+    end
+  end
+end

data/lib/crabfarm/live/reducer_runner_rspec.rb

@@ -0,0 +1,23 @@
+require 'crabfarm/utils/rspec_runner'
+require 'crabfarm/live/navigator_runner_rspec'
+
+module Crabfarm
+  module Live
+    class ReducerRunnerRSpec < NavigatorRunnerRSpec
+
+      def execute
+        @examples = Utils::RSpecRunner.run_spec_for spec_for(@target), live: true
+      end
+
+    private
+
+      def spec_for(_class)
+        route = Utils::Naming.route_from_constant(_class.to_s)
+        route = route.join(File::SEPARATOR)
+        route = route + '_spec.rb'
+        File.join('spec','reducers', route)
+      end
+
+    end
+  end
+end

data/lib/crabfarm/live/watcher.rb

@@ -1,10 +1,12 @@
 require 'listen'
+require 'crabfarm/utils/console'
 
 module Crabfarm
   module Live
     class Watcher
 
       PATH_RGX = /^\/[^\/]+\/(.*?)\.rb$/i
+      SPEC_RGX = /^\/[^\/]+\/(.*?)_spec\.rb$/i
 
       def initialize(_controller)
         @controller = _controller
@@ -26,15 +28,21 @@ module Crabfarm
     private
 
       def start_listener
-        base_path = File.join CF_PATH, 'app'
-        @listener = Listen.to(base_path) do |modified, added, removed|
+        app_path = File.join CF_PATH, 'app'
+        spec_path = File.join CF_PATH, 'spec'
+        @listener = Listen.to(app_path, spec_path) do |modified, added, removed|
           @candidates = (added + modified).map do |path|
-            class_from_path path[base_path.length..-1]
-          end.reject &:nil?
+            if path.start_with? app_path
+              class_from_path path[app_path.length..-1], PATH_RGX
+            else
+              class_from_path path[spec_path.length..-1], SPEC_RGX
+            end
+          end.reject(&:nil?)
         end
         @listener.start
       end
 
+
       def stop_listener
         @listener.stop if @listener
       end
@@ -43,7 +51,13 @@ module Crabfarm
         unless @candidates.nil?
           ActiveSupport::Dependencies.clear
           @candidates.each do |class_name|
-            target = class_name.constantize rescue nil
+            target = begin
+              class_name.constantize
+            rescue Exception => exc
+              @controller.display_external_error exc
+              nil
+            end
+
             if target and target < Crabfarm::Live::Interactable
               @controller.execute_live target
               break
@@ -54,9 +68,9 @@ module Crabfarm
         end
       end
 
-      def class_from_path(_filename)
+      def class_from_path(_filename, _regexp)
         _filename = _filename.gsub File::SEPARATOR, '/'
-        m = _filename.match PATH_RGX
+        m = _filename.match _regexp
         return nil if m.nil?
         Utils::Naming.decode_crabfarm_uri m[1]
       end

data/lib/crabfarm/modes/console.rb

@@ -61,7 +61,7 @@ module Crabfarm
           begin
             puts "Navigating, waiting to hit a reducer...".color Colors::NOTICE
             require 'crabfarm/modes/shared/snapshot_decorator'
-            TransitionService.with_navigator_decorator Shared::SnapshotDecorator do
+            Factories::Reducer.with_decorator Shared::SnapshotDecorator do
               @manager.navigate _name, _params
             end
             puts "Navigation completed".color Colors::NOTICE

data/lib/crabfarm/modes/live.rb

@@ -1,5 +1,6 @@
 require 'crabfarm/live/watcher'
 require 'crabfarm/live/controller'
+require 'crabfarm/utils/console'
 
 module Crabfarm
   module Modes
@@ -7,6 +8,8 @@ module Crabfarm
       extend self
 
       def start_watch
+        Utils::Console.system 'Starting crabfarm live'
+
         begin
           Crabfarm.enable_debugging!
           Crabfarm.install_live_backend!
@@ -18,11 +21,11 @@ module Crabfarm
 
         rescue SystemExit, Interrupt
           # nothing
-        rescue Exception => e
-          puts "Fatal error: #{e.to_s}".color Console::Colors::ERROR
-          puts e.backtrace
+        rescue Exception => exc
+          Utils::Console.error "Fatal error!"
+          Utils::Console.exception exc
         ensure
-          puts 'Exiting'
+          Utils::Console.system 'Exiting'
           Crabfarm.live.stop rescue nil
         end
       end

data/lib/crabfarm/modes/recorder/memento.rb

@@ -9,14 +9,10 @@ module Crabfarm
       module Memento
         extend self
 
-        def memento_path(_name)
-          File.join(GlobalState.mementos_path, _name + '.json.gz')
-        end
-
         def start(_target, _replay=false)
           return puts "Must provide a recording target" unless _target.is_a? String
 
-          target_path = memento_path _target
+          target_path = Utils::Resolve.memento_path _target
           return puts "Memento file does not exist: #{target_path}" if _replay and not File.exist? target_path
 
           start_crabtrap _replay, target_path

data/lib/crabfarm/modes/recorder/snapshot.rb

@@ -15,9 +15,9 @@ module Crabfarm
 
           begin
             puts "Navigating, waiting to hit a reducer...".color(Console::Colors::NOTICE)
-            service.with_navigator_decorator Shared::SnapshotDecorator do
+            Factories::Reducer.with_decorator Shared::SnapshotDecorator do
               if _query.nil?
-                service.with_navigator_decorator Shared::InteractiveDecorator do
+                Factories::Navigator.with_decorator Shared::InteractiveDecorator do
                   service.transition _context, _navigator
                 end
               else

data/lib/crabfarm/modes/shared/interactive_decorator.rb

@@ -61,7 +61,6 @@ module Crabfarm
             @i_params ||= InteractiveHash.new.merge! @params
           end
 
-          _navigator
         end
 
       end

data/lib/crabfarm/modes/shared/snapshot_decorator.rb

@@ -10,33 +10,28 @@ module Crabfarm
           include Crabfarm::Modes::Console::Colors
         end
 
-        def self.decorate(_navigator)
-
-          def _navigator.execute_reducer(_reducer)
-            loop do
-              name = Ask.input "-- Name for #{_reducer.class.to_s} snapshot (blank to skip)".color Colors::QUESTION
-              if name.empty?
-                puts "-- Skipping snapshot".color Colors::WARNING
-                break
+        def self.decorate(_reducer)
+          loop do
+            name = Ask.input "-- Name for #{_reducer.class.to_s} snapshot (blank to skip)".color Colors::QUESTION
+            if name.empty?
+              puts "-- Skipping snapshot".color Colors::WARNING
+              break
+            else
+              file_path = _reducer.class.snapshot_path name
+
+              if File.exist? file_path
+                puts "-- Could not save snapshot, file already exist!".color Colors::ERROR
               else
-                file_path = _reducer.class.snapshot_path name
-
-                if File.exist? file_path
-                  puts "-- Could not save snapshot, file already exist!".color Colors::ERROR
-                else
-                  dir_path = file_path.split(File::SEPARATOR)[0...-1]
-                  FileUtils.mkpath dir_path.join(File::SEPARATOR) if dir_path.length > 0
-                  File.write file_path, _reducer.raw_document
-                  puts "-- Snapshot written to #{file_path}".color Colors::RESULT
-                  break
-                end
+                dir_path = file_path.split(File::SEPARATOR)[0...-1]
+                FileUtils.mkpath dir_path.join(File::SEPARATOR) if dir_path.length > 0
+                File.write file_path, _reducer.raw_document
+                puts "-- Snapshot written to #{file_path}".color Colors::RESULT
+                break
               end
             end
-
-            _reducer.run
           end
 
-          _navigator
+          nil
         end
 
       end

data/lib/crabfarm/rspec/navigator_spec_helpers.rb

@@ -0,0 +1,56 @@
+require 'crabfarm/rspec/reducer_spy_manager'
+
+module Crabfarm
+  module RSpec
+    module NavigatorSpecHelpers
+
+      def navigate(_name=nil, _params={})
+        ensure_context_for :navigate
+
+        if _name.is_a? Hash
+          _params = _name
+          _name = nil
+        end
+
+        Factories::Reducer.with_decorator spy_manager do
+          if _name.nil?
+            return nil unless described_class < BaseNavigator # TODO: maybe raise an error here.
+            @navigator_state = @last_state = TransitionService.transition @navigator_context, described_class, _params
+          else
+            @last_state = TransitionService.transition @navigator_context, _name, (_params || {})
+          end
+        end
+      end
+
+      def state
+        @navigator_state || navigate(@navigator_params)
+      end
+
+      def last_state
+        @last_state
+      end
+
+      def spy_reducer(_name_or_class)
+        ensure_context_for :spy_reducer
+        reducer_class = Utils::Resolve.reducer_class _name_or_class
+        spy_manager.new_spy_for reducer_class
+      end
+
+      def browser(_session_id=nil)
+        ensure_context_for :browser
+        @navigator_context.pool.driver _session_id
+      end
+
+    private
+
+      def spy_manager
+        @navigator_spy_manager ||= ReducerSpyManager.new
+      end
+
+      def ensure_context_for(_name)
+        raise "'#{_name}' is only available in navigator specs." if @navigator_context.nil?
+      end
+
+    end
+  end
+end

data/lib/crabfarm/rspec/reducer_spec_helpers.rb

@@ -0,0 +1,29 @@
+module Crabfarm
+  module RSpec
+    module ReducerSpecHelpers
+
+      def reduce(_snapshot, _params={})
+        ensure_reducer_for :reduce
+        raise ArgumentError.new 'Must provide a snapshot for reducer specs' if _snapshot.nil?
+
+        snap_path = described_class.snapshot_path _snapshot
+        raise ArgumentError.new "Snapshot does not exist #{snap_path}" unless File.exist? snap_path
+
+        reducer = Factories::SnapshotReducer.build described_class, snap_path, (_params || {})
+        reducer.run
+        reducer
+      end
+
+      def reducer
+        @reducer_state ||= reduce @reducer_snapshot, @reducer_params
+      end
+
+    private
+
+      def ensure_reducer_for(_name)
+        raise "'#{_name}' is only available in reducer specs." unless described_class < Crabfarm::BaseReducer
+      end
+
+    end
+  end
+end

data/lib/crabfarm/rspec/reducer_spy.rb

@@ -0,0 +1,36 @@
+module Crabfarm
+  module RSpec
+    class ReducerSpy
+
+      Call = Struct.new(:target, :params)
+
+      attr_reader :original, :mock, :calls
+
+      def initialize(_original)
+        @original = _original
+        @calls = []
+        @mock = nil
+      end
+
+      def register_call(_target, _params)
+        @calls << Call.new(_target, _params)
+      end
+
+      def target
+        raise "'#{_original.to_s}' was not invoked" if calls.size == 0
+        calls.first.target
+      end
+
+      def params
+        raise "'#{_original.to_s}' was not invoked" if calls.size == 0
+        calls.first.params
+      end
+
+      def mock_with(_attributes)
+        @mock = _attributes
+        self
+      end
+
+    end
+  end
+end

data/lib/crabfarm/rspec/reducer_spy_manager.rb

@@ -0,0 +1,38 @@
+require 'crabfarm/rspec/reducer_spy'
+
+module Crabfarm
+  module RSpec
+
+    class ReducerSpyManager
+
+      def initialize
+        @spies = {}
+      end
+
+      def new_spy_for(_reducer_class)
+        @spies[_reducer_class.to_s] = ReducerSpy.new(_reducer_class)
+      end
+
+      # reducer decorator implementation
+
+      def prepare(_class, _target, _params)
+        spy = @spies[_class.to_s]
+        unless spy.nil?
+          spy.register_call _target, _params
+          if spy.mock
+            mock = _class.new _target, _params
+            mock.mock spy.mock
+
+            def mock.run
+              # do nothing
+            end
+
+            return mock
+          end
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/crabfarm/rspec.rb

@@ -1,76 +1,32 @@
-module Crabfarm
-  module RSpec
-
-    class Error < Crabfarm::Error; end
-
-    def reduce(_snapshot=nil, _options={})
-
-      raise Error.new "'reduce' is only available in reducer specs" unless described_class < Crabfarm::BaseReducer
-
-      if _snapshot.is_a? Hash
-        raise ArgumentException.new 'Invalid arguments' unless _options.nil?
-        _options = _snapshot
-        _snapshot = nil
-      end
-
-      snapshot_path = described_class.snapshot_path _snapshot
-      raise Error.new "Snapshot does not exist #{snapshot_path}" unless File.exist? snapshot_path
-
-      data = File.read snapshot_path
-      reducer = described_class.new data, _options
-      reducer.run
-      reducer
-    end
-
-    def navigate(_name=nil, _params={})
-
-      raise Error.new "'navigate' is only available in navigator specs" if @context.nil?
-
-      if _name.is_a? Hash
-        _params = _name
-        _name = nil
-      end
-
-      if _name.nil?
-        return nil unless described_class < BaseNavigator # TODO: maybe raise an error here.
-        @state = @last_state = TransitionService.transition @context, described_class, _params
-      else
-        @last_state = TransitionService.transition @context, _name, _params
-      end
-    end
-
-    def state
-      @state ||= navigate
-    end
-
-    def last_state
-      @last_state
-    end
-
-    def reducer
-      @reducer ||= reduce
-    end
-
-    def browser(_session_id=nil)
-      @context.pool.driver(_session_id)
-    end
-
-  end
-end
+require 'crabfarm/rspec/navigator_spec_helpers'
+require 'crabfarm/rspec/reducer_spec_helpers'
 
 RSpec.configure do |config|
-  config.include Crabfarm::RSpec
+  config.include Crabfarm::RSpec::NavigatorSpecHelpers
+  config.include Crabfarm::RSpec::ReducerSpecHelpers
 
   config.around(:example) do |example|
     if described_class < Crabfarm::BaseReducer
-      if example.metadata[:reducing] || example[:reducing_with_params]
-        @reducer = reduce example.metadata[:reducing], example.metadata[:reducing_with_params] || {}
+      @reducer_snapshot = example.metadata[:reducing]
+      @reducer_params = example.metadata[:with_params] || {}
+
+      begin
+        example.run
+      ensure
+        # store result in metadata so it can be accessed by formatters/reporters
+        example.metadata[:result] = @reducer_state.as_json if @reducer_state
       end
-      example.run
     elsif described_class < Crabfarm::BaseNavigator
-      Crabfarm::ContextFactory.with_context example.metadata[:navigating] do |ctx|
-        @context = ctx
-        example.run
+      Crabfarm.with_context example.metadata[:navigating] do |ctx|
+        @navigator_context = ctx
+        @navigator_params = (example.metadata[:with_params] || {})
+
+        begin
+          example.run
+        ensure
+          # store result in metadata so it can be accessed by formatters/reporters
+          example.metadata[:result] = @navigator_state.document if @navigator_state
+        end
       end
     else
       example.run

data/lib/crabfarm/support/phantom_runner.rb

@@ -0,0 +1,77 @@
+require 'timeout'
+require 'crabfarm/utils/processes'
+
+module Crabfarm
+  module Support
+    class PhantomRunner
+
+      PHANTOM_START_TM = 5 # seconds
+
+      def initialize(_config={})
+        @config = _config;
+        @process = nil
+      end
+
+      def port
+        @config[:port]
+      end
+
+      def start
+        logger.info "Starting phantomjs in port #{port}"
+        @process = spawn_phantomjs
+        logger.info "Phantomjs started (PID: #{@process.pid})"
+      end
+
+      def stop
+        unless @process.nil?
+          logger.info "Stopping phantomjs (PID: #{@process.pid})"
+          @process.stop
+          @process = nil
+          logger.info "Phantomjs stopped"
+        end
+      end
+
+    private
+
+      def spawn_phantomjs
+        proc = nil
+        begin
+          proc = Utils::Processes.start_logged_process 'phantomjs', phantomjs_cmd, logger
+          Timeout::timeout(PHANTOM_START_TM) { wait_for_server }
+        rescue ChildProcess::LaunchError
+          raise BinaryMissingError.new 'phantomjs', @config[:bin_path]
+        rescue Timeout::Error
+          proc.stop
+          raise
+        end
+        proc
+      end
+
+      def phantomjs_cmd
+        cmd = [@config[:bin_path]]
+        cmd << '--load-images=false' unless @config[:load_images]
+        cmd << "--proxy=#{@config[:proxy]}" unless @config[:proxy].nil?
+        cmd << "--webdriver=#{port}"
+        cmd << "--ssl-protocol=#{@config[:ssl]}" unless @config[:ssl].nil?
+        cmd << "--ignore-ssl-errors=true"
+        cmd << "--webdriver-loglevel=WARN"
+        cmd
+      end
+
+      def wait_for_server
+        loop do
+          begin
+            Net::HTTP.get_response(URI.parse("http://127.0.0.1:#{port}/status"))
+            break
+          rescue
+          end
+        end
+      end
+
+      def logger
+        Crabfarm.logger
+      end
+
+    end
+  end
+end

data/lib/crabfarm/templates/Gemfile.erb

@@ -12,5 +12,6 @@ gem "selenium-webdriver", "~> 2.45"
 gem "watir-webdriver"
 
 group :test do
+  gem "rspec", "~> 3.2.0"
   gem "rspec-nc"
 end

data/lib/crabfarm/transition_service.rb

@@ -1,19 +1,6 @@
 module Crabfarm
   class TransitionService
 
-    def self.with_navigator_decorator(_decorator)
-      @decorator = DecoratorChain.new @decorator, _decorator
-      begin
-        yield
-      ensure
-        @decorator = @decorator.base
-      end
-    end
-
-    def self.current_decorator
-      @decorator
-    end
-
     def self.transition(_context, _name, _params={})
       self.new(_context).transition(_name, _params)
     end
@@ -24,48 +11,16 @@ module Crabfarm
       @context = _context
     end
 
-    def transition(_name, _params={})
-      navigator_class = if _name.is_a? String or _name.is_a? Symbol
-        load_class_from_uri _name
-      else _name end
+    def transition(_name_or_class, _params={})
+      navigator_class = Utils::Resolve.navigator_class _name_or_class
 
       @context.prepare
-      @navigator = navigator_class.new @context, _params
-      @navigator = current_decorator.decorate @navigator unless current_decorator.nil?
-
+      @navigator = Factories::Navigator.build navigator_class, @context, _params
       @document = @navigator.run
       @document = @document.as_json if @document.respond_to? :as_json
 
       self
     end
 
-  private
-
-    def current_decorator
-      self.class.current_decorator
-    end
-
-    def load_class_from_uri(_uri)
-      class_name = Utils::Naming.decode_crabfarm_uri _uri
-      class_name.constantize
-    end
-
-    class DecoratorChain
-
-      attr_reader :base, :new
-
-      def initialize(_base, _new)
-        @base = _base
-        @new = _new
-      end
-
-      def decorate(_navigator)
-        _navigator = @new.decorate _navigator
-        return _navigator if @base.nil?
-        @base.decorate _navigator
-      end
-
-    end
-
   end
 end