prawn-grouping 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5692a85c43374a5de24dac64509274378aa5c72b
+  data.tar.gz: 79786b0fde6e1651615a4c09c5e6694618de1673
+SHA512:
+  metadata.gz: f714a85cc2fa8ef6d28201d306595bc7327d505d7e465c5ee94fbc28c9161797db9489efbca23cb892f7018607b08d91c8dcbb49f9edccd8ee0e26fb89aa40ab
+  data.tar.gz: ddeb45661c67e8a377ecf8b8c8baa8e7f27bcf934fb6c277ac6fda5ba12382adc64a942e2bcbe9c5933ef66f3546ef1a25392bda68d01c3e57e707e1eee97305

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/bin/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx-2
+  - jruby-19mode
+matrix:
+  allow_failures:
+    - rvm: rbx-2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Dengler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Prawn::Grouping
+
+[![Build Status](https://travis-ci.org/ddengler/prawn-grouping.png?branch=master)](https://travis-ci.org/ddengler/prawn-grouping)
+[![Code Climate](https://codeclimate.com/github/ddengler/prawn-grouping.png)](https://codeclimate.com/github/ddengler/prawn-grouping)
+
+An **experimental** gem to add a more flexible grouping option to the excellent prawn gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prawn-grouping'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prawn-grouping
+
+## Usage
+
+### Grouping
+
+```ruby
+Prawn::Document.new do
+  20.times { text "Regular text" }
+  group do
+    20.times { text "Paragraphs not separated unless neccessary" }
+  end
+end
+```
+
+### Nested Groups
+
+```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" }
+    end
+  end
+end
+```
+
+Do not overuse nesting because a every combination has to be tested recursively in a temporary document
+
+### Options
+
+Currently three callbacks are supported:
+
+* `:fits_current_context` A proc called before the content is rendered and does fit context.
+* `:fits_new_context` A proc called before the content is rendered and does fit a single context.
+* `:too_tall` A proc called before the content is rendered and does not fit a single context.
+
+```ruby
+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" }
+  end
+end
+```
+
+The example above starts a new page if the content is too tall for a single page. Default behavior would be to just append the content.
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/prawn-grouping/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run all rspec files"
+RSpec::Core::RakeTask.new("spec") do |c|
+  c.rspec_opts = "-t ~unresolved"
+end
+
+desc "Run a console with the gem loaded"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require_relative 'lib/prawn/grouping'
+
+  ARGV.clear
+  IRB.start
+end

data/lib/prawn/grouping.rb

@@ -0,0 +1,66 @@
+require "prawn"
+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.
+    #     <tt>:too_tall</tt>:: A proc called before the content is rendered and
+    #                          does not fit a single context.
+    #     <tt>:fits_new_context</tt>:: A proc called before the content is
+    #                                  rendered and does fit a single context.
+    #     <tt>:fits_current_context</tt>:: A proc called before the content is
+    #                                      rendered and does fit context.
+    #
+    def group(options = {}, &b)
+      too_tall             = options[:too_tall]
+      fits_new_context     = options[:fits_new_context]
+      fits_current_context = options[:fits_current_context]
+
+      # create a temporary document with current context and offset
+      pdf = create_box_clone
+      pdf.y = y
+      pdf.instance_exec pdf, &b
+
+      if pdf.page_count > 1
+        # create a temporary document without offset
+        pdf = create_box_clone
+        pdf.instance_exec pdf, &b
+
+        if pdf.page_count > 1
+          # does not fit new context
+          too_tall.call if too_tall
+          b.call(self)
+        else
+          fits_new_context.call if fits_new_context
+          bounds.move_past_bottom
+          b.call(self)
+        end
+        return false
+      else
+        # just render it
+        fits_current_context.call if fits_current_context
+        b.call(self)
+        return true
+      end
+    end
+
+    private
+
+    def create_box_clone
+      Prawn::Document.new(:page_size => state.page.size, :page_layout => state.page.layout) do |pdf|
+        pdf.margin_box = @bounding_box.dup
+        pdf.text_formatter = @text_formatter.dup
+        pdf.font_families.update font_families
+        pdf.font font.name
+        pdf.font_size font_size
+      end
+    end
+  end
+end
+
+Prawn::Document.extensions << Prawn::Grouping

data/lib/prawn/grouping/version.rb

@@ -0,0 +1,5 @@
+module Prawn
+  module Grouping
+    VERSION = "0.1.0"
+  end
+end

data/prawn-grouping.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn/grouping/version'
+
+Gem::Specification.new do |spec|
+  spec.name                      = "prawn-grouping"
+  spec.version                   = Prawn::Grouping::VERSION
+  spec.authors                   = ["Daniel Dengler"]
+  spec.email                     = ["me@ddengler.com"]
+  spec.summary                   = "Grouping extension for prawn pdf generator"
+  spec.homepage                  = ""
+  spec.license                   = "MIT"
+  spec.platform                  = Gem::Platform::RUBY
+
+  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.add_dependency "prawn", "~> 0.15.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  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 "growl"
+end

data/spec/grouping_spec.rb

@@ -0,0 +1,99 @@
+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 do
+      val = group { text "FooBar" }
+      (!!val).should == true
+    end
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 1
+  end
+
+  it "can be called with a block argument" do
+    pdf = Prawn::Document.new
+    val = pdf.group do |pdf| 
+      pdf.text "FooBar"
+    end
+    (!!val).should == true
+
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 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
+        20.times { text "FooBar 1" }
+      end
+      called.should == 1
+
+      group :fits_new_context => lambda { called = 2 } do
+        40.times { text "FooBar 2" }
+      end
+      called.should == 2
+
+      group :too_tall => lambda { called = 3 } do
+        100.times { text "FooBar 3" }
+      end
+      called.should == 3
+    end
+  end
+
+  it "should allow nesting of groups" do
+    pdf = Prawn::Document.new do
+      5.times { text "1" }
+      group do
+        10.times { text "1.1" }
+      end
+      group do
+        15.times { text "1.2" }
+        group do
+          30.times { text "1.2.1" }
+        end
+      end
+    end
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 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
+        text "Hello"
+        text "World"
+      end
+
+      # group should return a false value since a new page was started
+      (!!val).should == false
+    end
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 2
+    pages[0][:strings].should == []
+    pages[1][:strings].should == ["Hello", "World"]
+  end
+
+  
+
+  it "should group within individual column boxes" 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).
+      column_box([0, bounds.top], :width => bounds.width, :columns => 7) do
+        10.times do
+          group { 50.times { |i| text(i.to_s) } }
+        end
+      end
+    end
+
+    # 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'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler"
+Bundler.setup
+
+require "prawn/grouping"
+
+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'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: prawn-grouping
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Dengler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '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: 
+email:
+- me@ddengler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prawn/grouping.rb
+- lib/prawn/grouping/version.rb
+- prawn-grouping.gemspec
+- spec/grouping_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Grouping extension for prawn pdf generator
+test_files:
+- spec/grouping_spec.rb