prawn-grouping 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: edbb74b3d883deb5f4c93d595265253f98635aa5
-  data.tar.gz: 3e142422f61347f6b98aeb3bab1590748926c816
+SHA256:
+  metadata.gz: aead835d0b903112a2a55fc086b9062aac77d1d399750791339c94e2fbde1fdf
+  data.tar.gz: 5e10604251eadec6c215d2709ef5b14c5fe6092ae2ef5adb7d947a7371391769
 SHA512:
-  metadata.gz: 8733b32e99044a0a70faa3ebbdd4a99fdcdd70b8711fd38ac535f550c44c344bc66c18bd8c2461009f277bd422569e1dfef16b2d0c5868d2f0a4836ba46ad9af
-  data.tar.gz: 2a76aef33d15346be91de76fd408e74fbee24e0fd0229fe99cba441fae62f715dda77691c44369e71085c10f48933f31ca3505e07a58e3f4b63b99f7586292c8
+  metadata.gz: d90cbb94ac56d9035274f26554247246f68d7592ed3856f202392d5cf477742d2a49da1c4e6e6f13e2751555321aebec99e7550203848d1e96181ad8110547aa
+  data.tar.gz: f718a7b7f64615d53ca9c465d5a367417adb25622e29ea711d91b800f1e3337980ec5da90d1aeb914451931e7916923e478e6c638b035318237185cb0f899f5e

data/.gitignore

@@ -19,3 +19,6 @@ tmp
 /bin/
 
 /.DS_Store
+/gemfiles/prawn_2.gemfile.lock
+/gemfiles/prawn_1.gemfile.lock
+/test.pdf

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - rbx-2
-  - jruby-19mode
-matrix:
-  allow_failures:
-    - rvm: rbx-2
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - jruby-9.2.0.0
+
+gemfile:
+  - gemfiles/prawn_2_1.gemfile
+  - gemfiles/prawn_2_2.gemfile

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## v0.2.0
+
+* group parameter is no longer optional
+* official support for ruby 1.9, 2.0, 2.1, 2.2 and rubinius removed

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "guard"
+gem "guard-rspec"

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec do
+guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/prawn/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -27,8 +27,8 @@ Or install it yourself as:
 ```ruby
 Prawn::Document.new do
   20.times { text "Regular text" }
-  group do
-    20.times { text "Paragraphs not separated unless neccessary" }
+  group do |g|
+    20.times { g.text "Paragraphs not separated unless necessary" }
   end
 end
 ```
@@ -38,10 +38,10 @@ end
 ```ruby
 Prawn::Document.new do
   5.times { text "Regular text" }
-  group do
-    15.times { text "Paragraphs not separated unless neccessary" }
-    group do
-      30.times { text "Subparagraphs not separated unless neccessary" }
+  group do |g|
+    15.times { g.text "Paragraphs not separated unless necessary" }
+    group do |g|
+      30.times { g.text "Subparagraphs not separated unless necessary" }
     end
   end
 end
@@ -61,8 +61,8 @@ Currently three callbacks are supported:
 Prawn::Document.new do
   5.times { text "Regular text" }
 
-  group :too_tall => lambda { start_new_page } do
-    15.times { text "Paragraphs not separated unless neccessary" }
+  group :too_tall => lambda { start_new_page } do |g|
+    15.times { g.text "Paragraphs not separated unless necessary" }
   end
 end
 ```
@@ -72,18 +72,22 @@ The example above starts a new page if the content is too tall for a single page
 
 ## Troubleshooting
 
-When using JRuby a block parameter has to be supplied. For the other tested Interpreters this is optional.
+#### When using JRuby on a version smaller than 0.2.0 a block parameter has to be supplied. For the other tested Interpreters this was optional.
 
 ```ruby
 Prawn::Document.new do
   5.times { text "Regular text" }
 
   group do |g|
-    15.times { g.text "Paragraphs not separated unless neccessary" }
+    15.times { g.text "Paragraphs not separated unless necessary" }
   end
 end
 ```
 
+#### Manipulating objects within the group block
+
+The grouping internally works by executing the block one or _multiple_ times and checking the results, because deep copy did not work well for the original implementation in many cases. As a result you should not manipulate your data objects within the block. See issue #7 for details.
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/prawn-grouping/fork )

data/gemfiles/prawn_2_1.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../'
+
+gem "prawn", "~> 2.1.0"

data/gemfiles/prawn_2_2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../'
+
+gem "prawn", "~> 2.2.0"

data/lib/prawn/grouping.rb

@@ -3,9 +3,9 @@ require "prawn/grouping/version"
 
 module Prawn
   module Grouping
-    
+
     # Groups a given block vertiacally within the current context, if possible.
-    # 
+    #
     # Parameters are:
     #
     # <tt>options</tt>:: A hash for grouping options.
@@ -16,7 +16,7 @@ module Prawn
     #     <tt>:fits_current_context</tt>:: A proc called before the content is
     #                                      rendered and does fit context.
     #
-    def group(options = {}, &b)
+    def group(options = {})
       too_tall             = options[:too_tall]
       fits_new_context     = options[:fits_new_context]
       fits_current_context = options[:fits_current_context]
@@ -24,27 +24,27 @@ module Prawn
       # create a temporary document with current context and offset
       pdf = create_box_clone
       pdf.y = y
-      pdf.instance_exec pdf, &b
+      yield pdf
 
       if pdf.page_count > 1
         # create a temporary document without offset
         pdf = create_box_clone
-        pdf.instance_exec pdf, &b
+        yield pdf
 
         if pdf.page_count > 1
           # does not fit new context
           too_tall.call if too_tall
-          b.call(self)
+          yield self
         else
           fits_new_context.call if fits_new_context
           bounds.move_past_bottom
-          b.call(self)
+          yield self
         end
         return false
       else
         # just render it
         fits_current_context.call if fits_current_context
-        b.call(self)
+        yield self
         return true
       end
     end
@@ -56,11 +56,12 @@ module Prawn
         pdf.margin_box = @bounding_box.dup
         pdf.text_formatter = @text_formatter.dup
         pdf.font_families.update font_families
-        pdf.font font.name
+        pdf.font font.family
         pdf.font_size font_size
+        pdf.default_leading = default_leading
       end
     end
   end
 end
 
-Prawn::Document.extensions << Prawn::Grouping
+Prawn::Document.extensions << Prawn::Grouping

data/lib/prawn/grouping/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module Grouping
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/prawn-grouping.gemspec

@@ -16,17 +16,15 @@ Gem::Specification.new do |spec|
   spec.files                     = `git ls-files -z`.split("\x0")
   spec.test_files                = Dir[ "spec/*_spec.rb" ]
   spec.require_path              = "lib"
-  spec.required_ruby_version     = '>= 1.9.3'
-  spec.required_rubygems_version = ">= 1.3.6"
+  spec.required_ruby_version     = '>= 2.3.0'
+  spec.required_rubygems_version = ">= 2.0.0"
 
-  spec.add_dependency "prawn", "~> 1.0.0"
+  spec.add_dependency "prawn", ">= 2.0.0"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pdf-inspector", "~> 1.1.0"
-  spec.add_development_dependency "pdf-reader", "~>1.2"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pdf-inspector", "~> 1.3.0"
+  spec.add_development_dependency "pdf-reader", "~>2.1.0"
   spec.add_development_dependency "growl"
 end

data/spec/grouping_spec.rb

@@ -3,32 +3,32 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 describe "Prawn::Grouping" do
   it "returns true if the content fits in the current context" do
     pdf = Prawn::Document.new
-    val = pdf.group do |pdf| 
+    val = pdf.group do |pdf|
       pdf.text "FooBar"
     end
-    (!!val).should == true
+    expect(!!val).to eq(true)
 
     pages = PDF::Inspector::Page.analyze(pdf.render).pages
-    pages.size.should == 1
+    expect(pages.size).to eq(1)
   end
 
   it "calls callbacks according to content length" do
     called = 0
-    pdf = Prawn::Document.new do
-      group :fits_current_context => lambda { called = 1 } do |pdf|
+    pdf = Prawn::Document.new do |pdf|
+      pdf.group :fits_current_context => lambda { called = 1 } do |pdf|
         20.times { pdf.text "FooBar 1" }
       end
-      called.should == 1
+      expect(called).to eq(1)
 
-      group :fits_new_context => lambda { called = 2 } do |pdf|
+      pdf.group :fits_new_context => lambda { called = 2 } do |pdf|
         40.times { pdf.text "FooBar 2" }
       end
-      called.should == 2
+      expect(called).to eq(2)
 
-      group :too_tall => lambda { called = 3 } do |pdf|
+      pdf.group :too_tall => lambda { called = 3 } do |pdf|
         100.times { pdf.text "FooBar 3" }
       end
-      called.should == 3
+      expect(called).to eq(3)
     end
   end
 
@@ -46,29 +46,29 @@ describe "Prawn::Grouping" do
       end
     end
     pages = PDF::Inspector::Page.analyze(pdf.render).pages
-    pages.size.should == 2
+    expect(pages.size).to eq(2)
   end
 
   # the following example were copied to fit the original spec from
   # https://github.com/prawnpdf/prawn/blob/master/spec/document_spec.rb
   it "should group a simple block on a single page" do
-    pdf = Prawn::Document.new do
-      self.y = 50
-      val = group do |pdf|
+    pdf = Prawn::Document.new do |pdf|
+      pdf.y = 50
+      val = pdf.group do |pdf|
         pdf.text "Hello"
         pdf.text "World"
       end
 
       # group should return a false value since a new page was started
-      (!!val).should == false
+      expect(!!val).to eq(false)
     end
     pages = PDF::Inspector::Page.analyze(pdf.render).pages
-    pages.size.should == 2
-    pages[0][:strings].should == []
-    pages[1][:strings].should == ["Hello", "World"]
+    expect(pages.size).to eq(2)
+    expect(pages[0][:strings]).to eq([])
+    expect(pages[1][:strings]).to eq(["Hello", "World"])
   end
 
-  
+
 
   it "should group within individual column boxes" do
     pdf = Prawn::Document.new do
@@ -84,7 +84,25 @@ describe "Prawn::Grouping" do
 
     # Second page should start with a 0 because it's a new group.
     pages = PDF::Inspector::Page.analyze(pdf.render).pages
-    pages.size.should == 2
-    pages[1][:strings].first.should == '0'
+    expect(pages.size).to eq(2)
+    expect(pages[1][:strings].first).to eq('0')
+  end
+
+  it "should allow the use of inline formatting" do
+    pdf = Prawn::Document.new do
+      # Set up columns with grouped blocks of 0..49. 0 to 49 is slightly short
+      # of the height of one page / column, so each column should get its own
+      # group (every column should start with zero).
+      group do |pdf|
+        10.times { |i| pdf.text("<b>#{i}</b>", inline_format: true) }
+      end
+    end
+
+    # Second page should start with a 0 because it's a new group.
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    expect(pages.size).to eq(1)
+    expect(pages[0][:strings].first).to eq('0')
+
+    pdf.render_file 'test.pdf'
   end
-end
+end

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ require "pdf/reader"
 require "pdf/inspector"
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'

metadata

@@ -1,139 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: prawn-grouping
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Dengler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pdf-inspector
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -143,14 +115,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/prawn_2_1.gemfile
+- gemfiles/prawn_2_2.gemfile
 - lib/prawn/grouping.rb
 - lib/prawn/grouping/version.rb
 - prawn-grouping.gemspec
@@ -166,17 +141,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Grouping extension for prawn pdf generator