prawn_cocktail 0.5.4 → 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61d84eedd5dfe30a88044ffc489cb3045888cdc2d55ce2418ee1f7c1a8069034
+  data.tar.gz: 64c8bf00e8398dbf2f66c545c0c287633104b7fa9087694fb24ad3cabae60a90
+SHA512:
+  metadata.gz: 75f3e9779418238920e385563ec5b451e7dfd23d1be4379973ef6ac4f30eebbccdce798cae7a8116c3d33de7a1e8a5a52d093f2e385a39278ebddecf9b4e7824
+  data.tar.gz: be55301fdc96c7cc719a8a5f79b38de2a456c191f668a91fd14f8c24f75424de45712c5ab904e264ddf04b10943cf9a5f90c2e63ce20792c200b9d30ec6d8878

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ae9cb3b565e36682a2c6045e4f664388da4c73aa
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+inherit_gem:
+  barsoom_utils: shared_rubocop.yml

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in prawn_cocktail.gemspec
 gemspec
+
+group :development do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "rubocop"
+end

data/README.md

@@ -1,6 +1,6 @@
 # PrawnCocktail
 
-[![Build status](https://secure.travis-ci.org/barsoom/prawn_cocktail.png)](https://travis-ci.org/#!/barsoom/prawn_cocktail/builds)
+[![Ruby CI](https://github.com/barsoom/prawn_cocktail/actions/workflows/ci.yml/badge.svg)](https://github.com/barsoom/prawn_cocktail/actions/workflows/ci.yml)
 
 Simple documents, templates and helpers on top of Prawn.
 
@@ -8,8 +8,6 @@ Because writing Prawn documents PHP 4 style is no fun.
 
 If you're using this with Ruby on Rails, get [`PrawnCocktailRails`](http://github.com/barsoom/prawn_cocktail_rails).
 
-Ruby 1.9 only since we use and love instance\_exec.
-
 ![](http://upload.wikimedia.org/wikipedia/commons/f/f8/Cocktail_1_bg_060702.jpg)
 
 ## Usage
@@ -42,7 +40,7 @@ class InvoiceDocument < PrawnCocktail::Document
     {
       number: @invoice.id,
       amount: @invoice.amount,
-      customer_name: @invoice.customer_name
+      customer: { name: @invoice.customer_name }
     }
   end
 end
@@ -54,7 +52,7 @@ The document has `render` and `render_file(name)` methods, just like `Prawn::Doc
 
 The filename is not required. Other libraries like `PrawnCocktailRails` may make use of it.
 
-The `data` value is passed to the template as an `OpenStruct`.
+The `data` value is passed to the template as a recursive `OpenStruct`-like object.
 
 If the data becomes complex, you are advised to extract one or many builder classes like `InvoiceDocument::Data` and call those from `data`.
 
@@ -72,13 +70,15 @@ content do |data|
   move_down 10
   text "Amount: #{data.amount}"
   move_down 10
-  text data.customer_name
+  text data.customer.name
 end
 ```
 
 The `meta` declaration is optional. It takes a hash which will be passed to `Prawn::Document.new`. This is where you specify `page_size`, `page_layout` and such.
 
-The `content` block will be passed the data from the document as an `OpenStruct`, and will be rendered in the context of a `Prawn::Document` instance.
+The `content` block will be passed the data from the document as a recursive `OpenStruct`-type object (actually a `RecursiveClosedStruct` utility class).
+
+The `content` block will be rendered in the context of a `Prawn::Document` instance.
 
 ### Helpers
 
@@ -112,19 +112,19 @@ module BaseDocumentHelper
 end
 ```
 
-Any loaded module can be used as a helper, as long as its code can be run in the context of a Prawn document.
+Any loaded module can be used as a helper, as long as its methods can run in the context of a Prawn document.
 
 If you use `PrawnCocktailRails`, you can put modules in `app/documents/helpers`, e.g. `app/documents/helpers/base_document_helper.rb`, and they will be autoloaded.
 
 Note that you must explicitly declare the helpers you want. No helpers are automatically included. You can declare base helpers in a base document class, though, and they will be inherited.
 
-### `initialize_document`
+### `initialize_template`
 
-If you want to run some code in every document, use an `initialize_document` block:
+If you want to run some code in every template, use an `initialize_template` block:
 
 ``` ruby
 class BaseDocument < PrawnCocktail::Document
-  initialize_document do
+  initialize_template do
     font "Courier"
   end
 end
@@ -134,10 +134,14 @@ This is incidentally how helpers are implemented:
 
 ```
 def self.helper(mod)
-  initialize_document { extend mod }
+  initialize_template { extend mod }
 end
 ```
 
+You can have any number of template initializers, not just one.
+
+Template initializers in a superclass are inherited by subclasses, and the subclass can add its own.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -5,4 +5,4 @@ Rake::TestTask.new do |t|
   t.pattern = "spec/*_spec.rb"
 end
 
-task :default => :test
+task default: :test

data/lib/prawn_cocktail/document.rb

@@ -1,20 +1,18 @@
-require "prawn"
 require "active_support/core_ext/class/attribute"
 require "active_support/inflector"
-
 require_relative "renderer"
 
 module PrawnCocktail
   class Document
-    class_attribute :doc_initializers
-    self.doc_initializers = []
+    class_attribute :initializers
+    self.initializers = []
 
-    def self.initialize_document(&block)
-      self.doc_initializers += [block]
+    def self.initialize_template(&block)
+      self.initializers += [ block ]
     end
 
     def self.helper(mod)
-      initialize_document { extend mod }
+      initialize_template { extend mod }
     end
 
     def render
@@ -33,7 +31,7 @@ module PrawnCocktail
     private
 
     def renderer
-      @renderer ||= Renderer.new(template_name, data, self.class.doc_initializers)
+      @renderer ||= Renderer.new(template_name, data, initializers)
     end
 
     def template_name
@@ -44,5 +42,9 @@ module PrawnCocktail
       # Override in your subclass.
       {}
     end
+
+    def initializers
+      self.class.initializers
+    end
   end
 end

data/lib/prawn_cocktail/renderer.rb

@@ -1,19 +1,22 @@
+require "prawn"
 require_relative "template"
+require_relative "utils/recursive_closed_struct"
 
 module PrawnCocktail
   class Renderer
-    def initialize(template_name, data, doc_initializers)
+    def initialize(template_name, data, initializers)
+      @prawn_document_options = {}
       @template_name = template_name
       @data = data
-      @doc_initializers = doc_initializers
+      @initializers = initializers
     end
 
     def meta(opts)
-      @prawn_document_options = opts
+      @prawn_document_options.merge!(opts)
     end
 
     def content(&block)
-      @doc_initializers.each do |proc|
+      @initializers.each do |proc|
         prawn_document.instance_eval(&proc)
       end
 
@@ -37,11 +40,15 @@ module PrawnCocktail
     end
 
     def prawn_document
-      @doc ||= Prawn::Document.new(@prawn_document_options || {})
+      @doc ||= Prawn::Document.new(prawn_document_options)
+    end
+
+    def prawn_document_options
+      @prawn_document_options || {}
     end
 
     def data_object
-      OpenStruct.new(@data)
+      RecursiveClosedStruct.new(@data)
     end
   end
 end

data/lib/prawn_cocktail/utils/recursive_closed_struct.rb

@@ -0,0 +1,26 @@
+class RecursiveClosedStruct
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def include?(key)
+    @hash.include?(key)
+  end
+
+  def method_missing(name, *)
+    value = fetch(name)
+    if value.is_a?(Hash)
+      self.class.new(value)
+    else
+      value
+    end
+  end
+
+  private
+
+  def fetch(name)
+    @hash.fetch(name) do
+      raise NoMethodError.new("undefined method `#{name}' for #{self}")
+    end
+  end
+end

data/lib/prawn_cocktail/version.rb

@@ -1,3 +1,3 @@
 module PrawnCocktail
-  VERSION = "0.5.4"
+  VERSION = "0.8.1"
 end

data/prawn_cocktail.gemspec

@@ -1,20 +1,21 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'prawn_cocktail/version'
+require "prawn_cocktail/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "prawn_cocktail"
   gem.version       = PrawnCocktail::VERSION
-  gem.authors       = ["Henrik Nyh"]
-  gem.email         = ["henrik@barsoom.se"]
+  gem.authors       = [ "Henrik Nyh" ]
+  gem.email         = [ "henrik@barsoom.se" ]
   gem.summary       = "Simple documents, templates and helpers on top of Prawn."
   gem.homepage      = ""
+  gem.metadata      = { "rubygems_mfa_required" => "true" }
+
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = [ "lib" ]
 
   gem.add_dependency "prawn"
   gem.add_dependency "activesupport"

data/spec/fixtures/document.rb

@@ -6,7 +6,7 @@ end
 
 class TestDocument < PrawnCocktail::Document
   helper TestDocumentHelper
-  initialize_document { text "Init works." }
+  initialize_template { text "Init works." }
 
   def initialize(status)
     @status = status
@@ -15,10 +15,10 @@ class TestDocument < PrawnCocktail::Document
   private
 
   def data
-    { status: @status }
+    { nested: { status: @status } }
   end
 end
 
 class SubTestDocument < TestDocument
-  initialize_document { text "Sub-init works." }
+  initialize_template { text "Sub-init works." }
 end

data/spec/fixtures/sub_test_document.pdf.rb

@@ -2,5 +2,5 @@ meta page_size: "A4"
 
 content do |data|
   text "Sub test document"
-  status_line data.status
+  status_line data.nested.status
 end

data/spec/fixtures/test_document.pdf.rb

@@ -2,5 +2,5 @@ meta page_size: "A4"
 
 content do |data|
   text "Test document"
-  status_line data.status
+  status_line data.nested.status
 end

data/spec/integration_spec.rb

@@ -1,5 +1,4 @@
-require "minitest/autorun"
-require "minitest/pride"
+require_relative "spec_helper"
 require "pdf/inspector"
 
 require "prawn_cocktail"
@@ -14,11 +13,14 @@ describe PrawnCocktail do
 
   describe "#render" do
     it "has the right contents" do
-      assert_document_has_the_right_contents
+      assert_equal(
+        [ "Init works.", "Test document", "Status: success" ],
+        parse_strings(data),
+      )
     end
 
     it "has the right geometry" do
-      assert_document_has_the_right_geometry
+      assert_equal expected_geometry("A4"), parse_geometry(data)
     end
   end
 
@@ -29,11 +31,14 @@ describe PrawnCocktail do
     end
 
     it "has the right contents" do
-      assert_document_has_the_right_contents
+      assert_equal(
+        [ "Init works.", "Test document", "Status: success" ],
+        parse_strings(data),
+      )
     end
 
     it "has the right geometry" do
-      assert_document_has_the_right_geometry
+      assert_equal expected_geometry("A4"), parse_geometry(data)
     end
   end
 
@@ -45,27 +50,12 @@ describe PrawnCocktail do
     it "inherits initializers and helpers" do
       assert_equal(
         [ "Init works.", "Sub-init works.", "Sub test document", "Status: success" ],
-        parse_strings(data)
+        parse_strings(data),
       )
     end
   end
 end
 
-
-def assert_document_has_the_right_contents
-  assert_equal(
-    [ "Init works.", "Test document", "Status: success" ],
-    parse_strings(data)
-  )
-end
-
-def assert_document_has_the_right_geometry
-  assert_equal(
-    parse_geometry(data),
-    expected_geometry("A4")
-  )
-end
-
 def parse_strings(pdf_data)
   PDF::Inspector::Text.analyze(pdf_data).strings
 end
@@ -75,5 +65,5 @@ def parse_geometry(pdf_data)
 end
 
 def expected_geometry(name)
-  Prawn::Document::PageGeometry::SIZES[name]
+  PDF::Core::PageGeometry::SIZES[name]
 end

data/spec/recursive_closed_struct_spec.rb

@@ -0,0 +1,41 @@
+require_relative "spec_helper"
+
+require_relative "../lib/prawn_cocktail/utils/recursive_closed_struct"
+
+describe RecursiveClosedStruct do
+  it "provides readers from a hash" do
+    subject = RecursiveClosedStruct.new(key: "value")
+    assert_equal "value", subject.key
+  end
+
+  it "raises when there's no such key" do
+    subject = RecursiveClosedStruct.new(key: "value")
+    assert_raises(NoMethodError) do
+      subject.other_key
+    end
+  end
+
+  it "recurses through hashes" do
+    subject = RecursiveClosedStruct.new({
+      one: { two: { three: "four" } },
+    })
+    assert_equal "four", subject.one.two.three
+  end
+
+  describe "#include?" do
+    it "is true if that key exists" do
+      subject = RecursiveClosedStruct.new(real: true)
+      assert subject.include?(:real)
+    end
+
+    it "is false if that key does not exist" do
+      subject = RecursiveClosedStruct.new(real: true)
+      refute subject.include?(:imaginary)
+    end
+
+    it "recurses" do
+      subject = RecursiveClosedStruct.new(one: { two: "three" })
+      assert subject.one.include?(:two)
+    end
+  end
+end

data/spec/renderer_spec.rb

@@ -0,0 +1,14 @@
+require_relative "spec_helper"
+
+describe PrawnCocktail::Renderer do
+  describe "#meta" do
+    it "merges options if run multiple times" do
+      subject = PrawnCocktail::Renderer.new(nil, nil, nil)
+      subject.meta one: nil, two: 2
+      subject.meta one: 1, three: 3
+
+      expected = { one: 1, two: 2, three: 3 }
+      assert_equal expected, subject.send(:prawn_document_options)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: prawn_cocktail
 version: !ruby/object:Gem::Version
-  version: 0.5.4
-  prerelease: 
+  version: 0.8.1
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
-  requirement: &70243544258740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70243544258740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70243544274560 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70243544274560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70243544274080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70243544274080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pdf-inspector
-  requirement: &70243544273600 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70243544273600
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - henrik@barsoom.se
@@ -62,8 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -72,39 +84,44 @@ files:
 - lib/prawn_cocktail/document.rb
 - lib/prawn_cocktail/renderer.rb
 - lib/prawn_cocktail/template.rb
+- lib/prawn_cocktail/utils/recursive_closed_struct.rb
 - lib/prawn_cocktail/version.rb
 - prawn_cocktail.gemspec
 - spec/fixtures/document.rb
 - spec/fixtures/sub_test_document.pdf.rb
 - spec/fixtures/test_document.pdf.rb
 - spec/integration_spec.rb
+- spec/recursive_closed_struct_spec.rb
+- spec/renderer_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 3.2.31
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple documents, templates and helpers on top of Prawn.
 test_files:
 - spec/fixtures/document.rb
 - spec/fixtures/sub_test_document.pdf.rb
 - spec/fixtures/test_document.pdf.rb
 - spec/integration_spec.rb
-has_rdoc: 
+- spec/recursive_closed_struct_spec.rb
+- spec/renderer_spec.rb
+- spec/spec_helper.rb

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - rbx-19mode