seq 0.1.0 → 0.2.0

data/README.md

@@ -51,11 +51,11 @@ s.next #=> nil
 
 # Standard methods will increment the number of items that have been returned meaning
 # you have to call #reset
-s.reset 
+s.reset
 s.next #=> 1
 
 # You can use special ! versions to avoid incrementing the number of cycles, but note
-# this will start and finish based on the current index and items returned. So here 
+# this will start and finish based on the current index and items returned. So here
 # we are on the second item in the original list, ie. "2".
 
 s.map! {|i| i * 2 } #=> [4, 6, 8, 2, 4, 6, 8, 2, 4]
@@ -88,8 +88,19 @@ Lazily evaluates a block using starting list given.
 
 ```ruby
 fibs = Seq::Lazy.new([1,1]) {|list| list[-1] + list[-2] }
-fibs.take(10) #=> [1, 1, 2, 3, 5, 8, 13, 21, 34, 55] 
+fibs.take(10) #=> [1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
 fibs.take(20) #=> [89, 144, 233, 377, 610, 987, 1597, 2584, 4181, 6765, 10946, 17711, 28657, 46368, 75025, 121393, 196418, 317811, 514229, 832040]
 fibs.next! #=> 832040
 fibs.reset
 ```
+
+
+## Seq::Paged
+
+Returns elements from a page one at a time.
+
+```ruby
+s = Seq::Paged.new {|page| [page, page+1, page+2] }
+s.take(10)  #=> [0, 1, 2,  1, 2, 3,  2, 3, 4,  3]
+            #  extra spacing added to show pages
+```

data/lib/seq.rb

@@ -43,17 +43,17 @@ class Seq
     @items   = items
     @offset  = offset
     @default = default
-    
+
     self.reset
   end
-  
+
   # Resets the Seqs position to the same as when initialized.
   def reset
     @cycles = 0
     @index  = @offset
   end
-  
-  # @return Until ended it returns the next item from the list, when ended it returns 
+
+  # @return Until ended it returns the next item from the list, when ended it returns
   #  the default item.
   def next
     if ended?
@@ -62,27 +62,27 @@ class Seq
       @list[@index].tap { inc }
     end
   end
-  
-  # Increment the list index, the number of cycles completed and if at the end of 
+
+  # Increment the list index, the number of cycles completed and if at the end of
   # the list returns to the first item.
-  # 
+  #
   # @return [Integer] Number of items that have been returned.
   def inc
     if @index+1 == @list.size
-      @index = 0 
+      @index = 0
     else
       @index += 1
     end
     @cycles += 1
   end
-  
+
   # Iterates over each item as returned by #next until #ended?.
   def each
     until ended?
       yield self.next
     end
   end
-  
+
   include Enumerable
 
   # @return [Array] The items that would be returned by repeated calls to #next
@@ -90,7 +90,7 @@ class Seq
   # @raise [RangeError] If #infinite?, otherwise it creates an infinite loop!
   def entries
     raise RangeError if infinite?
-  
+
     i, c = @index, @cycles
     r = super
     @index, @cycles = i, c
@@ -101,7 +101,7 @@ class Seq
   def to_a
     @list
   end
-  
+
   # @return Whether the Seq returns infinite items.
   def infinite?
     @items == Float::INFINITY
@@ -111,15 +111,15 @@ class Seq
   def ended?
     @cycles >= @items
   end
-  
+
   # Any method called on a Seq with ending with !, will be caught by method
   # missing, it will then attempt to call the non ! version but will not
-  # alter the index or number of cycles completed. 
+  # alter the index or number of cycles completed.
   def method_missing(sym, *args, &block)
-    if sym.to_s[-1] == "!" && 
+    if sym.to_s[-1] == "!" &&
       self.respond_to?(sym.to_s[0..-2].to_sym) &&
       ! [:infinite?, :ended?, :to_a, :entries, :inc, :reset].include?(sym.to_s[0..-2].to_sym)
-      
+
       begin
         i, c = @index, @cycles
         self.send(sym.to_s[0..-2].to_sym, *args, &block)
@@ -133,5 +133,6 @@ class Seq
 end
 
 require 'seq/lazy'
+require 'seq/paged'
 require 'seq/random'
 require 'seq/version'

data/lib/seq/lazy.rb

@@ -19,7 +19,7 @@ class Seq
   #   fibs.take!(2) #=> [21, 34]
   #
   class Lazy < Seq
-    
+
     # Creates a new Lazy seq instance.
     #
     # @param list [Array] Starting values
@@ -35,24 +35,24 @@ class Seq
       @block   = block
       @offset  = offset
       @default = default
-      
+
       self.reset
     end
-    
-    # Resets the state of the lazy seq. It also calculates any values 
+
+    # Resets the state of the lazy seq. It also calculates any values
     # necessary to get to the offset.
     def reset
       @index  = @list.size
       @cycles = 0
-      
+
       until @list.size >= @offset
         @list[@index] = @block.call(@list[0..@index-1])
         @index += 1
       end
-      
+
       @index = @offset
     end
-    
+
     # @return [Object]
     #  Until ended it returns the next item from +list+ if it exists or calculates
     #  it then stores it in +list+, if ended it returns the default value.
@@ -68,6 +68,6 @@ class Seq
         end
       end
     end
-  
+
   end
 end

data/lib/seq/paged.rb

@@ -0,0 +1,81 @@
+class Seq
+
+  # Paged seqs evaluate a block that returns a page (Array) of items that are
+  # then returned one at a time. This is useful for working with web services
+  # that return pages of results, when you need them as a list.
+  #
+  # @example
+  #
+  #   s = Seq::Paged.new {|page| [page, page+1, page+2] }
+  #   s.take(10)  #=> [0, 1, 2,  1, 2, 3,  2, 3, 4,  3]
+  #               #  extra spacing added to show pages
+  #
+  #
+  #   require 'flickraw'
+  #   # Authenticate FlickRaw...
+  #
+  #   f = Seq::Paged.new {|page|
+  #     flickr.people.getPhotos(:user_id => 'me', :page => page).to_a
+  #   }
+  #   f.next #=> {"id"=>"8688497043", "owner"=>"75695140@N04", ...}
+  #   f.take(100).map {|photo| photo['title'] }.grep(/DSC/)
+  #   #=> ["DSC01485-edit", "DSC01485", "DSC01482-edit", "DSC01481", ...]
+  #
+  class Paged < Seq
+
+    # Creates a new Paged seq instance.
+    #
+    # @param offset [Integer] Index of item to start at
+    # @param default [Object] Value to return when finished
+    #
+    # @yield [page] Block to be called which returns the next page of items
+    # @yieldparam page [Integer] Page to be returned, begins at 0
+    def initialize(offset=0, default=nil, &block)
+      @block   = block
+      @offset  = offset
+      @default = default
+
+      self.reset
+    end
+
+    # Resets the state of the paged seq. It also calculates any values necessary
+    # to get to the offset.
+    def reset
+      @index = 0
+      @page  = 0
+      @done  = false
+      @items = []
+
+      until @index >= @offset
+        self.next
+      end
+    end
+
+    # @return Whether the Paged seq has returned all of its items.
+    def ended?
+      @index >= @items.size && @done
+    end
+
+    # @return [Object] Until ended it return the next item in the paged list. If
+    #  ended it returns the default value.
+    def next
+      return @default if ended?
+
+      while @items.size <= @index
+        loaded = @block.call(@page)
+        @page += 1
+        if loaded.empty?
+          @done = true
+          return @default
+        end
+        @items += loaded
+      end
+
+      item = @items[@index]
+      @index += 1
+      item
+    end
+
+
+  end
+end

data/lib/seq/version.rb

@@ -1,4 +1,3 @@
 class Seq
-  # Current version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/seq/lazy_test.rb

@@ -6,7 +6,7 @@ class LazySeqTest < MiniTest::Unit::TestCase
   def setup
     @seq = Seq::Lazy.new([1, 1]) {|l| l[-1] + l[-2] }
   end
-  
+
   def test_defines_next
     assert_equal 1, @seq.next
     assert_equal 1, @seq.next
@@ -16,10 +16,10 @@ class LazySeqTest < MiniTest::Unit::TestCase
     assert_equal 8, @seq.next
     assert_equal 13, @seq.next
   end
-  
+
   def test_offset_works
     s = Seq::Lazy.new([1], 1.0/0, 5) {|l| l.last + 1 }
     assert_equal 6, s.next
   end
 
-end
+end

data/test/seq/paged_test.rb

@@ -0,0 +1,46 @@
+$: << File.dirname(__FILE__) + '/..'
+require 'helper'
+
+class PagedSeqTest < MiniTest::Unit::TestCase
+
+  PAGE_COUNT = 10
+  PAGE_SIZE  = 10
+
+  def setup
+    @block = lambda do |page|
+      return [] if page == PAGE_COUNT
+      (page*PAGE_SIZE...page.succ*PAGE_SIZE).to_a
+    end
+  end
+
+  def test_defines_next
+    s = Seq::Paged.new(&@block)
+
+    0.upto(99) do |n|
+      assert_equal n, s.next
+    end
+
+    assert_equal nil, s.next
+  end
+
+  def test_defines_default
+    s = Seq::Paged.new(0, "default", &@block)
+
+    0.upto(99) do |n|
+      assert_equal n, s.next
+    end
+
+    assert_equal "default", s.next
+  end
+
+  def test_offset_works
+    s = Seq::Paged.new(5, &@block)
+
+    5.upto(99) do |n|
+      assert_equal n, s.next
+    end
+
+    assert_equal nil, s.next
+  end
+
+end

data/test/seq_test.rb

@@ -12,21 +12,21 @@ class SeqTest < MiniTest::Unit::TestCase
     assert_equal [], @empty.to_a
     assert_equal [1, 2, 3, 4], @seq.to_a
   end
-  
+
   def test_can_become_expanded_array
-    assert_raises RangeError do 
+    assert_raises RangeError do
       @empty.entries
     end
-    
+
     assert_equal [2, 3, 4, 1, 2, 3, 4], @seq.entries
   end
-  
+
   def test_can_iterate
     @empty.each_with_index do |a,i|
       assert_equal a, nil
       break if i > 3
     end
-    
+
     @seq.each_with_index do |a,i|
       assert_equal a, case i
         when 0 then 2
@@ -39,11 +39,11 @@ class SeqTest < MiniTest::Unit::TestCase
       end
     end
   end
-  
-  def test_gets_next_item 
+
+  def test_gets_next_item
     assert_equal nil, @empty.next
     assert_equal nil, @empty.next
-    
+
     assert_equal 2, @seq.next
     assert_equal 3, @seq.next
     assert_equal 4, @seq.next
@@ -62,4 +62,4 @@ class SeqTest < MiniTest::Unit::TestCase
     assert_equal 2, @seq.next
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-22 00:00:00.000000000 +01:00
-default_executable: 
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2156880320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +21,12 @@ dependencies:
         version: 2.3.1
   type: :development
   prerelease: false
-  version_requirements: *2156880320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
 description: ! "    A Seq is created with an array, and optionally a number of elements\n
   \   to return, an offset to start at and a default item to return when\n    ended.
   Call #next to return the next item.\n    \n    A Seq::Random will return randomly
@@ -37,14 +41,15 @@ files:
 - Rakefile
 - LICENCE
 - lib/seq/lazy.rb
+- lib/seq/paged.rb
 - lib/seq/random.rb
 - lib/seq/version.rb
 - lib/seq.rb
 - test/helper.rb
 - test/seq/lazy_test.rb
+- test/seq/paged_test.rb
 - test/seq/random_test.rb
 - test/seq_test.rb
-has_rdoc: true
 homepage: http://github.com/hawx/seq
 licenses: []
 post_install_message: 
@@ -65,12 +70,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Seqs cycle over elements of an array.
 test_files:
 - test/helper.rb
 - test/seq/lazy_test.rb
+- test/seq/paged_test.rb
 - test/seq/random_test.rb
 - test/seq_test.rb
+has_rdoc: