paged_groups 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb8ac318e3df020ef112bcfd9a44fef6883519682be6501de014e745148b4046
-  data.tar.gz: 7d69dea71a15bf728052cdfe80341e24b2ac32b0bc93bf5ab3f3b0891bd66b4f
+  metadata.gz: 1eda61f9a3bdd341677d3af689ecb14815ec276f83bfe771a7da256d8ac22a97
+  data.tar.gz: 6cd7fe9d4ac34e185bf52fdd1b5fdd4ca752585900f2bfa7b11241122e2e80b6
 SHA512:
-  metadata.gz: f60342818d52bce7432752e19d852f47a8cb28ca2a9d5216b39175e1ba47e9f71b9f2a8bb970751cc59a162c3d6af140dce2e95bfed5fcea53605b1b2b0e0c09
-  data.tar.gz: 86a0b7432ee2cefb13aad7b9e9d13ca1e2d35f60e93ebc58b798a2700816810be09c5b5580f26c10a6144664483aea9877108f1dea44983a20de647dc1c05c95
+  metadata.gz: 8f39ca31c34c31ae6afc77772749c385e99a9660c04f3052736b64367b69424dc7e89d58dfc24c888c1bbc8a776bd4deab3249aaf5eb7869eaa9b41fe4440a75
+  data.tar.gz: 3401fa08caffcac8e17b555436e1275b1a982a1484104ed8c7608666c813890f826d197e77110eb83c94bde84cf7b3a8f3686ac5483a13aa2e7d3dd2721d04df

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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.
+
 # 1.0.0 (January 26th, 2019)
 
 Initial Release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paged_groups (1.0.0)
+    paged_groups (2.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -62,10 +62,10 @@ data = [
 Let's use max page size of three for this example.  In the real-world a max page size of three is most likely too small but it fits our example data set above for illustration purpose; you should be able to extrapolate this out with larger sets and larger max page sizes.  To page this set we would execute:
 
 ````ruby
-pages = PagedGroups.builder(page_size: 3).add(*data).all
+pages = PagedGroups.builder(page_size: 3).add(data).all
 ````
 
-*Note:* We are using the splat (asterisk) operator to indicate each group is an argument.
+*Note:* Add accepts a two-dimensional array with the first dimension being the group and the second dimension being the record.
 
 our ````pages```` variable should now contain a two-dimensional array where dimension one is page and dimension two is record and would be:
 
@@ -103,7 +103,7 @@ There may be merit in placing *separator* record in between groups in the same p
 
 ````ruby
 pages = PagedGroups.builder(page_size: 3, space: true, spacer: { id: nil, name: '' })
-                   .add(*data)
+                   .add(data)
                    .all
 ````
 
@@ -152,8 +152,8 @@ other_data = [
   ]
 ]
 pages = PagedGroups.builder(page_size: 3, space: true, spacer: { id: nil, name: '' })
-                   .add(*data)
-                   .add(*other_data, force: true)
+                   .add(data)
+                   .add(other_data, force: true)
                    .all
 ````
 

data/lib/paged_groups/builder.rb

@@ -26,7 +26,9 @@ module PagedGroups
       clear
     end
 
-    def add(*groups, force: false)
+    # Groups should be a two-dimensional array with the first dimension being the group and
+    # the second dimension being the record.
+    def add(groups, force: false)
       dirty!
 
       groups.each { |group| insert(Array(group), force: force) }

data/lib/paged_groups/version.rb

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

data/spec/paged_groups/builder_spec.rb

@@ -28,28 +28,28 @@ describe ::PagedGroups::Builder do
 
   describe '#add and #all' do
     it 'should page groups' do
-      page_builder.add(hundred_rows)
+      page_builder.add([hundred_rows])
 
       expect(page_builder.all.length).to eq(1)
 
-      page_builder.add(twenty_rows)
-      page_builder.add(twenty_rows)
+      page_builder.add([twenty_rows])
+      page_builder.add([twenty_rows])
 
       expect(page_builder.all.length).to eq(2)
 
-      page_builder.add(twenty_rows)
+      page_builder.add([twenty_rows])
 
       expect(page_builder.all.length).to eq(3)
     end
 
     it 'should force add and space' do
-      page_builder.add(hundred_rows)
+      page_builder.add([hundred_rows])
 
       expect(page_builder.all.length).to eq(1)
       expect(page_builder.all.first.length).to eq(100)
 
-      page_builder.add(twenty_rows, force: true)
-      page_builder.add(twenty_rows, force: true)
+      page_builder.add([twenty_rows], force: true)
+      page_builder.add([twenty_rows], force: true)
 
       expect(page_builder.all.length).to eq(1)
       expect(page_builder.all.first.length).to eq(100 + 20 * 2 + 2)

data/spec/paged_groups/paged_groups_spec.rb

@@ -46,7 +46,7 @@ describe ::PagedGroups do
     let(:spacer) { { id: nil, name: '' } }
 
     specify 'Standard use-case example works as advertised' do
-      pages = PagedGroups.builder(page_size: page_size).add(*data).all
+      pages = PagedGroups.builder(page_size: page_size).add(data).all
 
       expected_pages = [
         [
@@ -77,7 +77,7 @@ describe ::PagedGroups do
 
     specify 'Spacing customization example works as advertised' do
       pages = PagedGroups.builder(page_size: page_size, space: true, spacer: spacer)
-                         .add(*data)
+                         .add(data)
                          .all
 
       expected_pages = [
@@ -118,8 +118,8 @@ describe ::PagedGroups do
       ]
 
       pages = PagedGroups.builder(page_size: page_size, space: true, spacer: spacer)
-                         .add(*data)
-                         .add(*other_data, force: true)
+                         .add(data)
+                         .add(other_data, force: true)
                          .all
 
       expected_pages = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paged_groups
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec