paged_groups 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eda61f9a3bdd341677d3af689ecb14815ec276f83bfe771a7da256d8ac22a97
-  data.tar.gz: 6cd7fe9d4ac34e185bf52fdd1b5fdd4ca752585900f2bfa7b11241122e2e80b6
+  metadata.gz: 231bf208ec9d23371baf0e22c950c4ad3fbc5c5eb1b60ea33ab9fed182755306
+  data.tar.gz: 476453f30988a874ee876fa8578556df085785834a1f500a0bcbf6b52b1c6254
 SHA512:
-  metadata.gz: 8f39ca31c34c31ae6afc77772749c385e99a9660c04f3052736b64367b69424dc7e89d58dfc24c888c1bbc8a776bd4deab3249aaf5eb7869eaa9b41fe4440a75
-  data.tar.gz: 3401fa08caffcac8e17b555436e1275b1a982a1484104ed8c7608666c813890f826d197e77110eb83c94bde84cf7b3a8f3686ac5483a13aa2e7d3dd2721d04df
+  metadata.gz: ad4d0e9d3e50af974373cc3b036ca32aaf75921328d07bf776c30a45dbd30a8c96cab243e1a0983153a76df3de4b1f77f41c33aaa6a76f59187f4ffcd206dffa
+  data.tar.gz: 5038f106275131795215f4648fdcebdc7d3c33ef4eafdffde8bdd0dfdb69eef4f4c6b73729db7fd9360eb60965d7b1dbda2d96c56965850eb45da04614455742

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 *.gem
 /tmp
+/coverage

data/.travis.yml

@@ -1,11 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=4f0bd2df4452665b4d6235501f7d663d730395d84b3ca09c55573ba79e9f8e82
 language: ruby
 rvm:
-# Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-- 2.3.8
-- 2.4.5
-- 2.5.3
-- 2.6.0
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
-- bundle exec rubocop
-- bundle exec rspec
+  - bundle exec rubocop
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.1.0 (February 14th, 2019)
+
+* Added limit option for builder.  This (optionally) ensures no group can exceed a given threshold.
+
 # 2.0.0 (January 29th, 2019)
 
 * Breaking Change: Builder#add signature changed from groups splat operator to two-dimensional array.  Splat operator introduces an under-the-hood copy and can impact performance with large argument lists.

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    paged_groups (2.0.0)
+    paged_groups (2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     ffi (1.9.25)
     formatador (0.2.5)
     guard (2.15.0)
@@ -25,7 +27,9 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.1)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -36,8 +40,8 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
@@ -60,19 +64,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
     thor (0.20.3)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
@@ -81,7 +94,9 @@ DEPENDENCIES
   guard-rspec (~> 4.7)
   paged_groups!
   rspec (~> 3.8)
-  rubocop (~> 0.59)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,6 +1,6 @@
 # paged_groups
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/paged_groups.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/paged_groups)
+[![Gem Version](https://badge.fury.io/rb/paged_groups.svg)](https://badge.fury.io/rb/paged_groups) [![Build Status](https://travis-ci.org/bluemarblepayroll/paged_groups.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/paged_groups) [![Maintainability](https://api.codeclimate.com/v1/badges/905e58c55e1ec9c61383/maintainability)](https://codeclimate.com/github/bluemarblepayroll/paged_groups/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/905e58c55e1ec9c61383/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/paged_groups/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 Imagine a two-dimensional data set (first dimension being group and second dimension being record) for which you wanted to page with the following rules:
 
@@ -139,7 +139,6 @@ Now, our resulting pages would become:
 ]
 ````
 
-
 ### Forcing Same Page
 
 Another customization that may come in handy is the ability to force-add groups to the current page.  For example, say we wanted to add another group to our initial data set, but we want it to end up on the same page as the last records:
@@ -192,6 +191,16 @@ Now the result pages would be:
 ]
 ````
 
+#### Group Size Upper Bound
+
+You may run into the case where a group is just so large that it makes more sense to just split it up than keep it atomic.  In this case, you can specify a 'limit' option:
+
+````ruby
+pages = PagedGroups.builder(page_size: 50, limit: 150).add(data).all
+````
+
+The above builder can now be interpreted as: *Each page should contain a maximum of 50 rows, but split groups over 150 rows*
+
 ## Contributing
 
 ### Development Environment Configuration

data/lib/paged_groups/builder.rb

@@ -14,11 +14,13 @@ module PagedGroups
 
     attr_reader :page_size,
                 :page_count,
+                :limit,
                 :row_count,
                 :space,
                 :spacer
 
-    def initialize(page_size: DEFAULT_PAGE_SIZE, space: false, spacer: nil)
+    def initialize(limit: nil, page_size: DEFAULT_PAGE_SIZE, space: false, spacer: nil)
+      @limit      = limit ? limit.to_i : nil
       @page_size  = page_size ? page_size.to_i : DEFAULT_PAGE_SIZE
       @space      = space || false
       @spacer     = spacer
@@ -31,7 +33,11 @@ module PagedGroups
     def add(groups, force: false)
       dirty!
 
-      groups.each { |group| insert(Array(group), force: force) }
+      groups.each do |group|
+        limit_group_slice(Array(group)).each do |split_group|
+          insert(split_group, force: force)
+        end
+      end
 
       self
     end
@@ -102,8 +108,12 @@ module PagedGroups
       not_top? && proposed_current_page_length > page_size
     end
 
-    def end_of_current_page?
-      @current_page.length >= page_size
+    def limit_group_slice(group)
+      if limit
+        group.each_slice(limit)
+      else
+        [group]
+      end
     end
   end
 end

data/lib/paged_groups/version.rb

@@ -8,5 +8,5 @@
 #
 
 module PagedGroups
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/paged_groups.gemspec

@@ -25,5 +25,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec', '~> 3.8')
-  s.add_development_dependency('rubocop', '~> 0.59')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
 end

data/spec/paged_groups/builder_spec.rb

@@ -26,6 +26,18 @@ describe ::PagedGroups::Builder do
 
   it { expect(page_builder.page_size).to eq(page_size) }
 
+  describe '#to_s' do
+    it 'should return page and row count' do
+      class_name = ::PagedGroups::Builder.name
+      page_count = subject.page_count
+      row_count = subject.row_count
+
+      expected = "[#{class_name}] Page Count: #{page_count}, Row Count: #{row_count}"
+
+      expect(subject.to_s).to eq(expected)
+    end
+  end
+
   describe '#add and #all' do
     it 'should page groups' do
       page_builder.add([hundred_rows])

data/spec/paged_groups/paged_groups_spec.rb

@@ -45,6 +45,36 @@ describe ::PagedGroups do
 
     let(:spacer) { { id: nil, name: '' } }
 
+    specify 'Number of records per page should never exceed limit' do
+      pages = PagedGroups.builder(page_size: page_size, limit: 4).add(data).all
+
+      expected_pages = [
+        [
+          { id: 1, name: 'Jordan' },
+          { id: 2, name: 'Pippen' },
+          { id: 3, name: 'Rodman' },
+          { id: 4, name: 'Harper' }
+        ],
+        [
+          { id: 5, name: 'Longley' },
+          { id: 6, name: 'Kukoc' },
+          { id: 7, name: 'Kerr' }
+        ],
+        [
+          { id: 8, name: 'Buechler' },
+          { id: 9, name: 'Wennington' },
+          { id: 10, name: 'Simpkins' }
+        ],
+        [
+          { id: 11, name: 'Caffey' },
+          { id: 12, name: 'Edwards' },
+          { id: 13, name: 'Salley' }
+        ]
+      ]
+
+      expect(pages).to eq(expected_pages)
+    end
+
     specify 'Standard use-case example works as advertised' do
       pages = PagedGroups.builder(page_size: page_size).add(data).all
 

data/spec/spec_helper.rb

@@ -7,4 +7,10 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require 'simplecov'
+require 'simplecov-console'
+
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
 require './lib/paged_groups'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paged_groups
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
@@ -44,14 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: 0.63.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 description: |2
       This library helps you page grouped-data when the grouped data can have different sizes.
       It provides a builder that understands how to split pages in a fashion where each page tries to