seq 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04b043d28893e71585895201f3a5d085e9cf84d0
+  data.tar.gz: ce20e14a0fdb7bd43662a4be84291448eaeb0fec
+SHA512:
+  metadata.gz: 9475c6c9e3a0e41908b29333cd8b1f49addb0db38f8979f653f5762737f50b943a08dedf8266ecbeeb6e8f1db041e1fbdc432cd76fd3a2c0d3fbbea41d941703
+  data.tar.gz: 1273cf4658e717e3c0ea102b28274a66c8860035e4ee03c85c69bddf3f55777e06c6199f2e8a4617c8c49c603f6ae6c83749c9c7f6b900760878501648b6e605

data/README.md

@@ -77,6 +77,8 @@ s.reject! {|i| i < 3 } #=> [3, 4]
 A subclass of Seq which returns random elements.
 
 ```ruby
+require 'seq/random'
+
 r = Seq::Random.new([1,2,3], 5)
 r.entries #=> [2, 1, 1, 3, 2]
 r.entries #=> [1, 3, 2, 3, 3]
@@ -87,6 +89,8 @@ r.entries #=> [1, 3, 2, 3, 3]
 Lazily evaluates a block using starting list given.
 
 ```ruby
+require 'seq/lazy'
+
 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(20) #=> [89, 144, 233, 377, 610, 987, 1597, 2584, 4181, 6765, 10946, 17711, 28657, 46368, 75025, 121393, 196418, 317811, 514229, 832040]
@@ -100,6 +104,8 @@ fibs.reset
 Returns elements from a page one at a time.
 
 ```ruby
+require 'seq/paged'
+
 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

@@ -1,3 +1,5 @@
+require 'seq/version'
+
 unless defined?(Float::INFINITY)
   # Define Float::INFINITY if not previously defined
   Float::INFINITY = 1.0/0
@@ -131,8 +133,3 @@ class Seq
     end
   end
 end
-
-require 'seq/lazy'
-require 'seq/paged'
-require 'seq/random'
-require 'seq/version'

data/lib/seq/paged.rb

@@ -1,3 +1,5 @@
+require 'seq'
+
 class Seq
 
   # Paged seqs evaluate a block that returns a page (Array) of items that are
@@ -51,6 +53,15 @@ class Seq
       end
     end
 
+    # Iterates over each item as returned by #next until #ended?.
+    def each
+      loop do
+        val = self.next
+        return if self.ended?
+        yield val
+      end
+    end
+
     # @return Whether the Paged seq has returned all of its items.
     def ended?
       @index >= @items.size && @done
@@ -75,7 +86,5 @@ class Seq
       @index += 1
       item
     end
-
-
   end
 end

data/lib/seq/pager.rb

@@ -0,0 +1,190 @@
+require 'seq'
+
+class Seq
+
+  # Takes a list of items and returns them in pages. This can be thought of as
+  # doing the opposite of {Seq::Paged}.
+  #
+  # @example
+  #
+  #   pages = Seq::Paged.new(5, 1..100)
+  #
+  #   pages.next     #=> [1,2,3,4,5]
+  #   pages.next     #=> [6,7,8,9,10]
+  #   pages.prev     #=> [1,2,3,4,5]
+  #   pages.page     #=> 0
+  #   pages.first?   #=> true
+  #   pages.last     #=> [96,97,98,99,100]
+  #
+  class Pager < Seq
+
+    # Creates a new instance of Pager.
+    #
+    # @param page_size [Integer] Size of page to use
+    # @param start_page [Integer] Page to start at
+    # @param elements [Enumerable] Items to initialize with
+    def initialize(page_size, start_page=nil, elements)
+      @pages = elements.each_slice(page_size).to_a
+      @curr  = start_page || 0
+    end
+
+    # Sets the current page. If the number passed is out of range, it will be
+    # set to within the bound of available pages.
+    #
+    # @param num [#to_i]
+    def page=(num)
+      unless num.respond_to?(:to_i)
+        raise ArgumentError.new("cannot call #to_i on argument")
+      end
+
+      num = num.to_i
+      num = 0           if num < 0
+      num = pages - 1   if num >= pages
+
+      @curr = num
+    end
+
+    # @return [Integer] The index of the current page.
+    def page
+      @curr
+    end
+
+    # @return [Integer] The total number of pages.
+    def pages
+      @pages.size
+    end
+
+    # @return Whether currently at the first page.
+    def first?
+      page == 0
+    end
+
+    # Moves to the first page.
+    #
+    # @return [Seq::Pager]
+    def first!
+      @curr = 0
+      self
+    end
+
+    # Moves to the first page, and returns it.
+    #
+    # @return [Array]
+    def first
+      @curr = 0
+      curr
+    end
+
+    # @return Whether currently at the last page.
+    def last?
+      page == pages - 1
+    end
+
+    # Moves to the last page.
+    #
+    # @return [Seq::Pager]
+    def last!
+      @curr = 0
+      self
+    end
+
+    # Moves to the last page, and returns it.
+    #
+    # @return [Array]
+    def last
+      @curr = pages - 1
+      curr
+    end
+
+    # @return [Array] Returns the current page without modifying the
+    #   current position.
+    def curr
+      @pages[@curr]
+    end
+
+    # Moves the next page, and returns the {Pager} object itself. If at the last
+    # page it simply returns +self+.
+    #
+    # @return [Seq::Pager]
+    def next!
+      @curr += 1 unless last?
+      self
+    end
+
+    # Moves to, and returns the next page. If at the last page it returns +nil+.
+    #
+    # @return [Array, nil]
+    def next
+      return if last?
+
+      @curr += 1
+      curr
+    end
+
+    # Moves to the previous page, and returns the {Pager} object itself. If at
+    # the first page it simply returns +self+.
+    #
+    # @return [Seq::Pager]
+    def prev!
+      @curr -= 1 unless first?
+      self
+    end
+
+    # Moves to, and returns, the previous page. If at the first page it returns
+    # +nil+.
+    #
+    # @return [Array, nil]
+    def prev
+      return if first?
+
+      @curr -= 1
+      curr
+    end
+
+    # Provides a list of page numbers, useful for populating a page selector. It
+    # returns an array containing three arrays, some of which may be empty.
+    #
+    # @param left [Integer] Maximum number of elements for the left-most array
+    # @param middle [Integer] Maximum number of elements for either side of the
+    #   current page
+    # @param right [Integer] Maximum number of elemengts for the right-most array
+    #
+    # @example
+    #
+    #   s = Seq::Pager.new(10, 1..1000)
+    #
+    #   s.range(2, 2, 2)
+    #   #=> [[0, 1, 2, 3, 4, 5, 6, 7], [], [98, 99]]
+    #
+    #   s.page = 10
+    #   s.range(2, 2, 2)
+    #   #=> [[0, 1, 2], [48, 49, 50, 51, 52], [98, 99]]
+    #
+    def range(left, middle, right)
+      width = 2 * middle + 1
+
+      if pages < left + width + right
+        return [(0..pages-1).to_a, [], []]
+      end
+
+      if page < left + middle + 1
+        left   = (0..left+width-1).to_a
+        middle = []
+        right  = (pages-right..pages-1).to_a
+
+      elsif page > (pages - 1) - right - middle - 1
+        left   = (0..left-1).to_a
+        middle = []
+        right  = (pages-right-width..pages-1).to_a
+
+      else
+        left   = (0..left-1).to_a
+        middle = (page-middle..page+middle).to_a
+        right  = (pages-right..pages-1).to_a
+      end
+
+      [left, middle, right]
+    end
+
+  end
+end

data/lib/seq/random.rb

@@ -7,10 +7,10 @@ class Seq
   # @example
   #
   #   s = Seq::Random.new([1,2,3,4,5])
-  #   s.take(6) #=> [1, 4, 5, 3, 1, 2] 
+  #   s.take(6) #=> [1, 4, 5, 3, 1, 2]
   #
   class Random < Seq
-  
+
     # Creates a new Random seq instance.
     #
     # @param list [Array] List of values to cycle over
@@ -19,8 +19,8 @@ class Seq
     def initialize(list=[], items=Float::INFINITY, default=nil)
       super(list, items, 0, default)
     end
-    
-    # @return Until ended it returns a randomly selected item from the list, when 
+
+    # @return Until ended it returns a randomly selected item from the list, when
     #  ended it returns the default value.
     def next
       if ended?
@@ -29,6 +29,6 @@ class Seq
         @list[rand(@list.size).to_i].tap { inc }
       end
     end
-  
+
   end
 end

data/lib/seq/version.rb

@@ -1,3 +1,3 @@
 class Seq
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/helper.rb

@@ -2,7 +2,9 @@ $: << File.dirname(__FILE__)
 $: << File.dirname(__FILE__) + '/../lib'
 
 require 'seq'
+require 'seq/lazy'
+require 'seq/paged'
+require 'seq/pager'
+require 'seq/random'
 
-require 'rubygems'
-require 'minitest/unit'
 require 'minitest/autorun'

data/test/seq/lazy_test.rb

@@ -1,7 +1,7 @@
 $: << File.dirname(__FILE__) + '/..'
 require 'helper'
 
-class LazySeqTest < MiniTest::Unit::TestCase
+class LazySeqTest < MiniTest::Test
 
   def setup
     @seq = Seq::Lazy.new([1, 1]) {|l| l[-1] + l[-2] }

data/test/seq/paged_test.rb

@@ -1,7 +1,7 @@
 $: << File.dirname(__FILE__) + '/..'
 require 'helper'
 
-class PagedSeqTest < MiniTest::Unit::TestCase
+class PagedSeqTest < MiniTest::Test
 
   PAGE_COUNT = 10
   PAGE_SIZE  = 10
@@ -13,6 +13,16 @@ class PagedSeqTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_defines_each
+    s = Seq::Paged.new do |page|
+      page == 3 ? [] : [1]
+    end
+
+    s.each do |n|
+      assert_equal n, 1
+    end
+  end
+
   def test_defines_next
     s = Seq::Paged.new(&@block)
 
@@ -33,7 +43,7 @@ class PagedSeqTest < MiniTest::Unit::TestCase
     assert_equal "default", s.next
   end
 
-  def test_offset_works
+  def test_offset
     s = Seq::Paged.new(5, &@block)
 
     5.upto(99) do |n|
@@ -43,4 +53,17 @@ class PagedSeqTest < MiniTest::Unit::TestCase
     assert_equal nil, s.next
   end
 
+  def test_entries
+    s = Seq::Paged.new do |page|
+      case page
+      when 0 then [1,2,3]
+      when 1 then [4]
+      when 2 then [5,6]
+      when 3 then []
+      when 4 then [100]
+      end
+    end
+
+    assert_equal s.entries, [1,2,3,4,5,6]
+  end
 end

data/test/seq/pager_test.rb

@@ -0,0 +1,109 @@
+$: << File.dirname(__FILE__) + '/..'
+require 'helper'
+
+class PagerSeqTest < MiniTest::Test
+
+  PAGE_COUNT = 10
+  PAGE_SIZE  = 10
+
+
+  def test_page_setting
+    s = Seq::Pager.new(5, 1..100)
+    s.page = 5
+    assert_equal s.page, 5
+  end
+
+  def test_page_setting_error
+    s = Seq::Pager.new(5, 1..100)
+
+    assert_raises ArgumentError do
+      s.page = Object.new
+    end
+  end
+
+  def test_page
+    s = Seq::Pager.new(5, 1..100)
+    assert_equal s.page, 0
+  end
+
+  def test_first?
+    s = Seq::Pager.new(5, 1..100)
+    assert s.first?
+
+    s.next
+    refute s.first?
+  end
+
+  def test_last?
+    s = Seq::Pager.new(5, 1..10)
+    refute s.last?
+
+    s.next
+    assert s.last?
+  end
+
+  def test_pages
+    s = Seq::Pager.new(5, 1..100)
+    assert_equal s.pages, 20
+  end
+
+  def test_curr
+    s = Seq::Pager.new(5, 1..100)
+    assert_equal [1,2,3,4,5], s.curr
+  end
+
+  def test_next
+    s = Seq::Pager.new(5, 1..100)
+    assert_equal [6,7,8,9,10], s.next
+  end
+
+  def test_next!
+    s = Seq::Pager.new(5, 1..100)
+    s = s.next!
+    assert_instance_of Seq::Pager, s
+    assert_equal       s.page, 1
+  end
+
+  def test_prev
+    s = Seq::Pager.new(5, 1..100)
+    assert_equal [6,7,8,9,10], s.next!.next!.prev
+  end
+
+  def test_prev!
+    s = Seq::Pager.new(5, 1..100)
+    s = s.next!.next!.prev!
+    assert_instance_of Seq::Pager, s
+    assert_equal       s.page, 1
+  end
+
+  def test_range
+    s = Seq::Pager.new(2, 1..100)
+    assert_equal s.range(2, 2, 2), [[0, 1, 2, 3, 4, 5, 6], [], [48, 49]]
+
+    s.page = 25
+    assert_equal s.range(2, 2, 2), [[0, 1], [23, 24, 25, 26, 27], [48, 49]]
+
+    s.last
+    assert_equal s.range(2, 2, 2), [[0, 1], [], [43, 44, 45, 46, 47, 48, 49]]
+  end
+
+  def test_range_cases
+    s = Seq::Pager.new(50, 1..100)
+    assert_equal s.range(2, 2, 2), [[0, 1], [], []]
+
+    s = Seq::Pager.new(2, 1..100)
+
+    s.page = 4
+    assert_equal s.range(2, 2, 2), [[0, 1, 2, 3, 4, 5, 6], [], [48, 49]]
+
+    s.page = 5
+    assert_equal s.range(2, 2, 2), [[0, 1], [3, 4, 5, 6, 7], [48, 49]]
+
+    s.page = 44
+    assert_equal s.range(2, 2, 2), [[0, 1], [42, 43, 44, 45, 46], [48, 49]]
+
+    s.page = 45
+    assert_equal s.range(2, 2, 2), [[0, 1], [], [43, 44, 45, 46, 47, 48, 49]]
+  end
+
+end

data/test/seq/random_test.rb

@@ -1,12 +1,12 @@
 $: << File.dirname(__FILE__) + '/..'
 require 'helper'
 
-class RandomSeqTest < MiniTest::Unit::TestCase
+class RandomSeqTest < MiniTest::Test
 
   def setup
     @seq = Seq::Random.new([1, 2, 3], 6)
   end
-  
+
   def test_defines_next
     assert_includes [1,2,3], @seq.next
     assert_includes [1,2,3], @seq.next
@@ -16,9 +16,9 @@ class RandomSeqTest < MiniTest::Unit::TestCase
     assert_includes [1,2,3], @seq.next
     assert_equal nil, @seq.next
   end
-  
+
   def test_cycles_correct_times
     assert_equal 6, @seq.entries.size
   end
 
-end
+end

data/test/seq_test.rb

@@ -1,7 +1,7 @@
 $: << File.dirname(__FILE__)
 require 'helper'
 
-class SeqTest < MiniTest::Unit::TestCase
+class SeqTest < MiniTest::Test
 
   def setup
     @empty = Seq.new
@@ -29,14 +29,15 @@ class SeqTest < MiniTest::Unit::TestCase
 
     @seq.each_with_index do |a,i|
       assert_equal a, case i
-        when 0 then 2
-        when 1 then 3
-        when 2 then 4
-        when 3 then 1
-        when 4 then 2
-        when 5 then 3
-        when 6 then 4
-      end
+                      when 0 then 2
+                      when 1 then 3
+                      when 2 then 4
+                      when 3 then 1
+                      when 4 then 2
+                      when 5 then 3
+                      when 6 then 4
+                      else assert_fail
+                      end
     end
   end
 
@@ -61,5 +62,4 @@ class SeqTest < MiniTest::Unit::TestCase
     @seq.reset
     assert_equal 2, @seq.next
   end
-
 end

metadata

@@ -1,33 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: seq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Joshua Hawxwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.1
   type: :development
   prerelease: false
   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
+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
   selected elements from the array.\n    A Seq::Lazy will lazily evaluate a block
@@ -40,44 +37,46 @@ files:
 - README.md
 - Rakefile
 - LICENCE
+- lib/seq.rb
 - lib/seq/lazy.rb
-- lib/seq/paged.rb
-- lib/seq/random.rb
+- lib/seq/pager.rb
 - lib/seq/version.rb
-- lib/seq.rb
+- lib/seq/random.rb
+- lib/seq/paged.rb
+- test/seq_test.rb
 - test/helper.rb
+- test/seq/pager_test.rb
+- test/seq/random_test.rb
 - test/seq/lazy_test.rb
 - test/seq/paged_test.rb
-- test/seq/random_test.rb
-- test/seq_test.rb
 homepage: http://github.com/hawx/seq
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Seqs cycle over elements of an array.
 test_files:
+- test/seq_test.rb
 - test/helper.rb
+- test/seq/pager_test.rb
+- test/seq/random_test.rb
 - test/seq/lazy_test.rb
 - test/seq/paged_test.rb
-- test/seq/random_test.rb
-- test/seq_test.rb
 has_rdoc: