spidr_epg_gem 0.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzdmOTg4MGRhNTFkZDQwOGY4NGQ2ZjY2ZjExYjI3NzE4M2Y0NDVjOQ==
+  data.tar.gz: !binary |-
+    YjY2Yjg4MTMxMTU5MDRiMDdiNzU5MTg1Yzc1ZmZkOGMzYTY4YTZkZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2NkNTBkMjRkODk3NGY1MWJjZWZmYzcxNGU2Y2E0MTgyYWE0ZmFkODBmZjk5
+    MDk0MjE2MGQ1ZDRlYWU1MGU4ZmFmOGM4ZDViYjlkNDFlOTlmMTIxNjM0NDVi
+    YTViNjFmNzU5YmVkMThkNGZjMThhYjU1YzQ4MTI4OGJjMDU5ZDA=
+  data.tar.gz: !binary |-
+    OTA0OWI4OGYwZDBkOWM4ZjFlYmU1YzkyYWMwMzhjNjc1NTUxZDEyZTRkYjgy
+    NjZjMTljNTYwYWNhZDNhMTNiYzhlMTU5NzY2ZmIzOGZhMDM1Zjc1YWE5MDJl
+    ZGFjMmY2ZTY2Zjc0ODM5M2Y0MjM4NjI0YmIxN2Y1OWNjZDcxMzQ=

data/lib/spidr.rb

@@ -0,0 +1,3 @@
+require 'spidr/agent'
+require 'spidr/spidr'
+require 'spidr/version'

data/lib/spidr_epg/actions/actions.rb

@@ -0,0 +1,83 @@
+require 'spidr/actions/exceptions/paused'
+require 'spidr/actions/exceptions/skip_link'
+require 'spidr/actions/exceptions/skip_page'
+
+module Spidr
+  #
+  # The {Actions} module adds methods to {Agent} for controlling the
+  # spidering of links.
+  #
+  module Actions
+    #
+    # Continue spidering.
+    #
+    # @yield [page]
+    #   If a block is given, it will be passed every page visited.
+    #
+    # @yieldparam [Page] page
+    #   The page to be visited.
+    #
+    def continue!(&block)
+      @paused = false
+      return run(&block)
+    end
+
+    #
+    # Sets the pause state of the agent.
+    #
+    # @param [Boolean] state
+    #   The new pause state of the agent.
+    #
+    def pause=(state)
+      @paused = state
+    end
+
+    #
+    # Pauses the agent, causing spidering to temporarily stop.
+    #
+    # @raise [Paused]
+    #   Indicates to the agent, that it should pause spidering.
+    #
+    def pause!
+      @paused = true
+      raise(Paused)
+    end
+
+    #
+    # Determines whether the agent is paused.
+    #
+    # @return [Boolean]
+    #   Specifies whether the agent is paused.
+    #
+    def paused?
+      @paused == true
+    end
+
+    #
+    # Causes the agent to skip the link being enqueued.
+    #
+    # @raise [SkipLink]
+    #   Indicates to the agent, that the current link should be skipped,
+    #   and not enqueued or visited.
+    #
+    def skip_link!
+      raise(SkipLink)
+    end
+
+    #
+    # Causes the agent to skip the page being visited.
+    #
+    # @raise [SkipPage]
+    #   Indicates to the agent, that the current page should be skipped.
+    #
+    def skip_page!
+      raise(SkipPage)
+    end
+
+    protected
+
+    def initialize_actions(options={})
+      @paused = false
+    end
+  end
+end

data/lib/spidr_epg/actions/exceptions/action.rb

@@ -0,0 +1,9 @@
+module Spidr
+  module Actions
+    #
+    # The base {Actions} exception class.
+    #
+    class Action < RuntimeError
+    end
+  end
+end

data/lib/spidr_epg/actions/exceptions/paused.rb

@@ -0,0 +1,11 @@
+require 'spidr/actions/exceptions/action'
+
+module Spidr
+  module Actions
+    #
+    # An {Actions} exception class used to pause a running {Agent}.
+    #
+    class Paused < Action
+    end
+  end
+end

data/lib/spidr_epg/actions/exceptions/skip_link.rb

@@ -0,0 +1,12 @@
+require 'spidr/actions/exceptions/action'
+
+module Spidr
+  module Actions
+    #
+    # An {Actions} exception class which causes a running {Agent} to
+    # skip a link.
+    #
+    class SkipLink < Action
+    end
+  end
+end

data/lib/spidr_epg/actions/exceptions/skip_page.rb

@@ -0,0 +1,12 @@
+require 'spidr/actions/exceptions/action'
+
+module Spidr
+  module Actions
+    #
+    # An {Actions} exception class which causes a running {Agent} to
+    # skip a {Page}, and all links within that page.
+    #
+    class SkipPage < Action
+    end
+  end
+end

data/lib/spidr_epg/actions/exceptions.rb

@@ -0,0 +1,4 @@
+require 'spidr/actions/exceptions/action'
+require 'spidr/actions/exceptions/paused'
+require 'spidr/actions/exceptions/skip_link'
+require 'spidr/actions/exceptions/skip_page'

data/lib/spidr_epg/actions.rb

@@ -0,0 +1,2 @@
+require 'spidr/actions/exceptions'
+require 'spidr/actions/actions'