#
#--
# GScraper - A web-scraping interface to various Google Services.
#
# Copyright (c) 2007-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#++
#

require 'gscraper/search/result'
require 'gscraper/page'

module GScraper
  module Search
    class Page < GScraper::Page

      #
      # Selects the results using the specified _block_.
      #
      #   page.results_with { |result| result.title =~ /blog/ }
      #
      def results_with(&block)
        select(&block)
      end

      #
      # Selects the results with the matching _title_. The _title_ may be
      # either a String or a Regexp. If _block_ is given, each matching
      # result will be passed to the _block_.
      #
      #   page.results_with_title('hackety org') #=> Page
      #
      #   page.results_with_title(/awesome/) do |result|
      #     puts result.url
      #   end
      #
      def results_with_title(title,&block)
        if title.kind_of?(Regexp)
          results = results_with { |result| result.title =~ title }
        else
          results = results_with { |result| result.title == title }
        end

        results.each(&block) if block
        return results
      end

      #
      # Selects the results with the matching _url_. The _url_ may be
      # either a String or a Regexp. If _block_ is given, each matching
      # result will be passed to the _block_.
      #
      #   page.results_with_url(/\.com/) # => Page
      #
      #   page.results_with_url(/^https:\/\//) do |result|
      #     puts result.title
      #   end
      #
      def results_with_url(url,&block)
        if url.kind_of?(Regexp)
          results = results_with { |result| result.url =~ url }
        else
          results = results_with { |result| result.url == url }
        end

        results.each(&block) if block
        return results
      end

      #
      # Selects the results with the matching _summary_. The _summary_ may
      # be either a String or a Regexp. If _block_ is given, each matching
      # result will be passed to the _block_.
      #
      #   page.results_with_summary(/cheese cake/) # => Page
      #
      #   page.results_with_summary(/Scientifically/) do |result|
      #     puts result.url
      #   end
      #
      def results_with_summary(summary,&block)
        if summary.kind_of?(Regexp)
          results = results_with { |result| result.summary =~ summary }
        else
          results = results_with { |result| result.summary == summary }
        end

        results.each(&block) if block
        return results
      end

      #
      # Returns an Array containing the ranks of the results within the
      # Page.
      #
      #   page.ranks # => [...]
      #
      def ranks
        map { |result| result.rank }
      end

      #
      # Returns an Array containing the titles of the results within the
      # Page.
      #
      #   page.titles # => [...]
      #
      def titles
        map { |result| result.title }
      end

      #
      # Returns an Array containing the URLs of the results within the
      # Page.
      #
      #   page.urls # => [...]
      #
      def urls
        map { |result| result.url }
      end

      #
      # Returns an Array containing the summaries of the results within the
      # Page.
      #
      #   page.summaries # => [...]
      #
      def summaries
        map { |result| result.summary }
      end

      #
      # Returns an Array containing the cached URLs of the results within
      # the Page.
      #
      #   page.cached_urls # => [...]
      #
      def cached_urls
        map { |result| result.cached_url }.compact
      end

      #
      # Returns an Array containing the cached pages of the results within
      # the Page.
      #
      #   page.cached_pages # => [...]
      #
      def cached_pages
        map { |result| result.cached_page }.compact
      end

      #
      # Returns an Array containing the similar Query URLs of the results
      # within the Page.
      #
      #   page.similar_urls # => [...]
      #
      def similar_urls
        map { |result| result.similar_url }.compact
      end

      #
      # Iterates over each result's rank within the Page, passing each to
      # the given _block_.
      #
      #   each_rank { |rank| puts rank }
      #
      def each_rank(&block)
        ranks.each(&block)
      end

      #
      # Iterates over each result's title within the Page, passing each to
      # the given _block_.
      #
      #   each_title { |title| puts title }
      #
      def each_title(&block)
        titles.each(&block)
      end

      #
      # Iterates over each result's url within the Page, passing each to
      # the given _block_.
      #
      #   each_url { |url| puts url }
      #
      def each_url(&block)
        urls.each(&block)
      end

      #
      # Iterates over each result's summary within the Page, passing each
      # to the given _block_.
      #
      #   each_summary { |summary| puts summary }
      #
      def each_summary(&block)
        summaries.each(&block)
      end

      #
      # Iterates over each result's cached URLs within the Page, passing
      # each to the given _block_.
      #
      #   each_cached_url { |url| puts url }
      #
      def each_cached_url(&block)
        cached_urls.each(&block)
      end

      #
      # Iterates over each result's cached pages within the Page, passing
      # each to the given _block_.
      #
      #   each_cached_page { |page| puts page.readlines }
      #
      def each_cached_page(&block)
        cached_pages.each(&block)
      end

      #
      # Iterates over each result's similar Query URLs within the Page,
      # passing each to the given _block_.
      #
      #   each_similar_url { |url| puts url }
      #
      def each_similar_url(&block)
        similar_urls.each(&block)
      end

      #
      # Returns the ranks of the results that match the specified _block_.
      #
      #   page.ranks_of { |result| result.title =~ /awesome/ }
      #
      def ranks_of(&block)
        results_with(&block).ranks
      end

      #
      # Returns the titles of the results that match the specified _block_.
      #
      #   page.titles_of { |result| result.url.include?('www') }
      #
      def titles_of(&block)
        results_with(&block).titles
      end

      #
      # Returns the urls of the results that match the specified _block_.
      #
      #   page.urls_of { |result| result.summary =~ /awesome pants/ }
      #
      def urls_of(&block)
        results_with(&block).urls
      end

      #
      # Returns the summaries of the results that match the specified
      # _block_.
      #
      #   page.summaries_of { |result| result.title =~ /what if/ }
      #
      def summaries_of(&block)
        results_with(&block).summaries
      end

      #
      # Returns the cached URLs of the results that match the specified
      # _block_.
      #
      #   page.cached_urls_of { |result| result.title =~ /howdy/ }
      #
      def cached_urls_of(&block)
        results_with(&block).cached_urls
      end

      #
      # Returns the cached pages of the results that match the specified
      # _block_. If _options_ are given, they will be used in accessing
      # the cached pages.
      #
      #   page.cached_pages_of { |result| result.title =~ /dude/ }
      #
      def cached_pages_of(options={},&block)
        results_with(&block).cached_pages(options)
      end

      #
      # Returns the similar query URLs of the results that match the
      # specified _block_.
      #
      #   page.similar_urls_of { |result| result.title =~ /what if/ }
      #
      def similar_urls_of(&block)
        results_with(&block).similar_urls
      end

    end
  end
end