page.rb in gscraper-0.1.4

- old
+ new
@@ -113,111 +113,249 @@
         return results
       end
 
       #
       # Returns an Array containing the ranks of the results within the
-      # Page. If _block_ is given, each rank will be passed to the _block_.
+      # Page.
       #
       #   page.ranks # => [...]
       #
-      #   page.ranks do |rank|
-      #     puts ranks
-      #   end
-      #
-      def ranks(&block)
-        mapped = map { |result| result.rank }
-
-        mapped.each(&block) if block
-        return mapped
+      def ranks
+        map { |result| result.rank }
       end
 
       #
       # Returns an Array containing the titles of the results within the
-      # Page. If _block_ is given, each title will be passed to the _block_.
+      # Page.
       #
       #   page.titles # => [...]
       #
-      #   page.titles do |title|
-      #     puts title
-      #   end
-      #
-      def titles(&block)
-        mapped = map { |result| result.title }
-
-        mapped.each(&block) if block
-        return mapped
+      def titles
+        map { |result| result.title }
       end
 
       #
       # Returns an Array containing the URLs of the results within the
-      # Page. If _block_ is given, each URL will be passed to the _block_.
+      # Page.
       #
       #   page.urls # => [...]
       #
-      #   page.urls do |url|
-      #     puts url
-      #   end
-      #
-      def urls(&block)
-        mapped = map { |result| result.url }
-
-        mapped.each(&block) if block
-        return mapped
+      def urls
+        map { |result| result.url }
       end
 
       #
       # Returns an Array containing the summaries of the results within the
-      # Page. If _block_ is given, each summary will be passed to the
-      # _block_.
+      # Page.
       #
       #   page.summaries # => [...]
       #
-      #   page.summaries do |summary|
-      #     puts summary
-      #   end
+      def summaries
+        map { |result| result.summary }
+      end
+
       #
-      def summaries(&block)
-        mapped = map { |result| result.summaries }
+      # Returns an Array containing the cached URLs of the results within
+      # the Page.
+      #
+      #   page.cached_urls # => [...]
+      #
+      def cached_urls
+        map { |result| result.cached_url }
+      end
 
-        mapped.each(&block) if block
-        return mapped
+      #
+      # Returns an Array containing the cached pages of the results within
+      # the Page. If _opts_ are given, they will be used in accessing the
+      # cached page.
+      #
+      #   page.cached_pages # => [...]
+      #
+      def cached_pages(opts={})
+        map { |result| result.cached_page(opts) }
       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 }
+      end
+
+      #
+      # Returns an Array containing the similar Queries of the results
+      # within the Page.
+      #
+      #   page.similar_queries # => [...]
+      #
+      def similar_queries
+        map { |result| result.similar_query }
+      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_. If _opts_ are given, they will be used
+      # in accessing the cached pages.
+      #
+      #   each_cached_page { |page| puts page.readlines }
+      #
+      def each_cached_page(opts={},&block)
+        cached_pages(opts).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
+
+      #
+      # Iterates over each result's similar Query within the Page, passing
+      # each to the given _block_.
+      #
+      #   each_similar_query do |q|
+      #     q.first_page do |page|
+      #       puts page.urls.join("\n")
+      #     end
+      #   end
+      #
+      def each_similar_query(&block)
+        similar_queries.each(&block)
+      end
+
+      #
       # Returns the ranks of the results that match the specified _block_.
       #
-      #   page.ranks_of { |result result.title =~ /awesome/ }
+      #   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') }
+      #   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/ }
+      #   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/ }
+      #   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 _opts_ are given, they will be used in accessing
+      # the cached pages.
+      #
+      #   page.cached_pages_of { |result| result.title =~ /dude/ }
+      #
+      def cached_pages_of(opts={},&block)
+        results_with(&block).cached_pages(opts)
+      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
+
+      #
+      # Returns the similar Queries of the results that match the
+      # specified _block_.
+      #
+      #   page.similar_queries_of { |result| result.title =~ /hackety/ }
+      #
+      def similar_queries_of(&block)
+        results_with(&block).similar_queries
       end
 
     end
   end
 end