proforma-prawn-renderer 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d353eb183e887bb3f96ea8d3c79cfc113fef27bf2057042b717e881dc445252b
-  data.tar.gz: f71dc344909b7b68c44702b6cd2e4124a7849cfe2477e96e802a314734baa954
+  metadata.gz: 023bb2b06bdf92d4065a6c52bf6e6e522e21bf20ffe1c058797a68c8c83455bc
+  data.tar.gz: 9553acd72e862cff0b2d1b186bffd646187f51b17a9cf543f2ae3add94a3d3d6
 SHA512:
-  metadata.gz: 41b223807262ed034c8a2ff0cf81c19bd1390993e202655d17ec306ed5306ffa108bf346d2c8845866d5625b5e8159d414dd440e57fae9d0addc52c3f8a9d1e8
-  data.tar.gz: fda9c314d671fb2671ce73164a5081d35c996c8c689f141ef55c7049c1255e66bea2017c5ebcb12ed88f109bd5b5d8d89c932c7ffe5af404dd455a63aa81071d
+  metadata.gz: 204cabc54005e2f46ea269a8de1a4353ceffb952bb75af3de0051239bb78ff20f2d37bbcbdc3687b2a134f455dcb2c99fb3067ca296feda338d630eb7ad0c18a
+  data.tar.gz: e789d0114fa922808f7b373e0c2cae1044a53fb102a1a838a5e179d440fb2e7f123aa4016b536c509ad2d88e8d3529d4fb3920779aa10dde9b754d167d8f29b8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.3 (July 7th, 2019)
+
+* Added better pane width balancing algorithm that fixes some width assignment bugs.
+
 # 1.0.2 (June 14th, 2019)
 
 * Added overflow and min_font_size attributes to cell_style for tables.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    proforma-prawn-renderer (1.0.2)
+    proforma-prawn-renderer (1.0.3)
       prawn (~> 2)
       prawn-table (~> 0)
       proforma (~> 1)

data/lib/proforma/prawn_renderer/balanced_set.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Proforma
+  class PrawnRenderer
+    # This class can balance out an un-even set of values.
+    class BalancedSet
+      class << self
+        def calculate(values, sum, round: 2)
+          free_spots = values.count(&:nil?)
+
+          if free_spots.positive?
+            available_value = sum - values.map(&:to_f).reduce(0, :+)
+
+            new_values = divide(free_spots, available_value, round)
+
+            values = values.map { |v| v || new_values.shift }
+          end
+
+          balance(values, sum, round)
+        end
+
+        private
+
+        def balance(values, sum, round)
+          difference = sum - values.map(&:to_f).reduce(0, :+)
+
+          return values if difference.zero?
+
+          diff_spots = divide(values.length, difference, round)
+
+          values.map.with_index { |value, index| value + diff_spots[index] }
+        end
+
+        def divide(count, sum, round)
+          spot_value = (sum / count.to_f).round(round)
+
+          remainder = sum - (spot_value * count)
+
+          Array.new(count) { |i| i.zero? ? spot_value + remainder : spot_value }
+        end
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/pane_renderer.rb

@@ -7,6 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'balanced_set'
 require_relative 'renderer'
 
 module Proforma
@@ -78,18 +79,12 @@ module Proforma
       end
 
       def make_column_widths(columns)
-        {}.tap do |column_widths|
-          columns.each_with_index do |column, index|
-            label_width = column.label_width
-            value_width = column.value_width
+        widths = columns.map { |col| [col.label_width, col.value_width] }.flatten
 
-            label_index = index * 2
-            value_index = label_index + 1
-
-            column_widths[label_index] = calculate_width(label_width) if label_width
-            column_widths[value_index] = calculate_width(value_width) if value_width
-          end
-        end
+        BalancedSet.calculate(widths, 100)
+                   .map
+                   .with_index { |v, i| [i, calculate_width(v)] }
+                   .to_h
       end
 
       def base_value_cell_style

data/lib/proforma/prawn_renderer/version.rb

@@ -9,6 +9,6 @@
 
 module Proforma
   class PrawnRenderer
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

data/spec/fixtures/component_test.pdf

@@ -17,7 +17,7 @@ endobj
 >>
 endobj
 4 0 obj
-<< /Length 2011
+<< /Length 2009
 >>
 stream
 q
@@ -173,7 +173,7 @@ ET
 0.0 0.0 0.0 SCN
 
 BT
-224.0954 567.858 Td
+216.036 567.858 Td
 /F2.0 10 Tf
 [<4944204e756d626572>] TJ
 ET
@@ -182,7 +182,7 @@ ET
 0.0 0.0 0.0 SCN
 
 BT
-361.0954 568.062 Td
+353.036 568.062 Td
 /F1.0 10 Tf
 [<31>] TJ
 ET
@@ -258,14 +258,14 @@ xref
 0000000109 00000 n 
 0000000158 00000 n 
 0000000215 00000 n 
-0000002278 00000 n 
-0000002576 00000 n 
-0000002678 00000 n 
+0000002276 00000 n 
+0000002574 00000 n 
+0000002676 00000 n 
 trailer
 << /Size 8
 /Root 2 0 R
 /Info 1 0 R
 >>
 startxref
-2775
+2773
 %%EOF

data/spec/proforma/prawn_renderer/balanced_set_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require './spec/spec_helper'
+
+describe ::Proforma::PrawnRenderer::BalancedSet do
+  describe '#calculate' do
+    specify 'with no explicit values' do
+      expect(described_class.calculate([nil], 100)).to            eq([100])
+      expect(described_class.calculate([nil, nil], 100)).to       eq([50, 50])
+      expect(described_class.calculate([nil, nil, nil], 100)).to  eq([33.34, 33.33, 33.33])
+    end
+
+    specify 'with some explicit values' do
+      expect(described_class.calculate([50, nil], 100)).to          eq([50, 50])
+      expect(described_class.calculate([46.53, nil, nil], 100)).to  eq([46.53, 26.73, 26.74])
+    end
+
+    specify 'with all explicit values' do
+      expect(described_class.calculate([50, 50], 100)).to eq([50, 50])
+      expect(described_class.calculate([50, 41, 30], 100)).to eq([43, 34, 23])
+      expect(described_class.calculate([2, 40, 37], 100)).to  eq([9, 47, 44])
+    end
+  end
+end

data/spec/proforma/prawn_renderer_spec.rb

@@ -80,4 +80,38 @@ describe ::Proforma::PrawnRenderer do
 
     expect(documents.first.contents).to eq(pdf)
   end
+
+  specify 'panes with un-even column widths equalize' do
+    data = [
+      { id: 1, name: 'Chicago Bulls' },
+      { id: 2, name: 'Indiana Pacers' },
+      { id: 3, name: 'Boston Celtics' }
+    ]
+
+    template = {
+      children: [
+        {
+          type: 'Pane',
+          columns: [
+            {
+              label_width: '0.5',
+              value_width: '',
+              lines: [
+                { label: 'Label', value: 'Value' }
+              ]
+            },
+            {
+              label_width: '10',
+              value_width: '',
+              lines: [
+                { label: 'Label', value: 'Value' }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+
+    Proforma.render(data, template, renderer: Proforma::PrawnRenderer.new)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proforma-prawn-renderer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -203,6 +203,7 @@ files:
 - bin/console
 - bin/render
 - lib/proforma/prawn_renderer.rb
+- lib/proforma/prawn_renderer/balanced_set.rb
 - lib/proforma/prawn_renderer/banner_renderer.rb
 - lib/proforma/prawn_renderer/header_renderer.rb
 - lib/proforma/prawn_renderer/pane_renderer.rb
@@ -217,6 +218,7 @@ files:
 - spec/fixtures/component_test.yml
 - spec/fixtures/snapshots/user_details.yml
 - spec/fixtures/snapshots/user_list.yml
+- spec/proforma/prawn_renderer/balanced_set_spec.rb
 - spec/proforma/prawn_renderer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/proforma-prawn-renderer
@@ -247,5 +249,6 @@ test_files:
 - spec/fixtures/component_test.yml
 - spec/fixtures/snapshots/user_details.yml
 - spec/fixtures/snapshots/user_list.yml
+- spec/proforma/prawn_renderer/balanced_set_spec.rb
 - spec/proforma/prawn_renderer_spec.rb
 - spec/spec_helper.rb