prawn-attachment 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cedf55c7c97ed821fc7d9a61cd6f88538eb959d17cd2fe11f8a5aaae2d734c0
+  data.tar.gz: 5ad7f5ce585f97f508fda3d6a257f4f7bc47197887914c1424aaa506f4747bad
+SHA512:
+  metadata.gz: c4c2452fa385e45480211f2744e6cfaa7d96131acff1472e8652ef7802500b5c895eeb16358a134520f77492a06db8533abba8d4b3707d9a899ecf8e5384ab36
+  data.tar.gz: '09fdd61fd399f58a78898b15faaea1b4738f1fa7617a0aa8dd1edc9e9bdbbdf02d4fc15bd1208a9d936beefdecbf10f5d604eb09ce079361458a395742357e65'

data/.github/workflows/main.yml

@@ -0,0 +1,41 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Tests - Ruby ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          # - "3.1"
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
+          # - ruby-head
+          - jruby-9.3
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run rspec 
+      run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - name: Lint Ruby code with RuboCop
+      run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.pdf
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sam.lown@cabify.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in prawn-attachment.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sam Lown
+
+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,53 @@
+# Prawn::Attachment
+
+Attach files to Prawn PDF documents according to the PDF/A-3 standard.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prawn-attachment'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install prawn-attachment
+
+## Usage
+
+Simply require the gem and attach your files the PDF document you're building with Prawn.
+
+```ruby
+require "prawn"
+require "prawn/attachment"
+
+Prawn::Document.generate("hello.pdf") do
+  text "Hello World!"
+  attach "./data.json"
+end
+```
+
+If you open up the PDF in a view that supports PDF/A-3, like the standard [Adobe Acrobat Reader](https://get.adobe.com/reader/) you should be able to see the attached data in the "attachments" section.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/invopop/prawn-attachment. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/invopop/prawn-attachment/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Prawn::Attachment project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/invopop/prawn-attachment/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "prawn/attachment"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/attach.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "prawn"
+require_relative "../lib/prawn/attachment"
+
+Prawn::Document.generate("hello.pdf") do
+  text "Hello World!"
+  attach "data.json", File.open("./data.json")
+end

data/example/data.json

@@ -0,0 +1,3 @@
+{
+	"message": "Hello World Indeed!"
+}

data/lib/pdf/core/embedded_files.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module PDF
+  module Core
+    module EmbeddedFiles # :nodoc:
+      # The maximum number of children to fit into a single node in the
+      # EmbeddedFiles tree.
+      NAME_TREE_CHILDREN_LIMIT = 20 # :nodoc:
+
+      # The EmbeddedFiles name tree in the Name dictionary (see
+      # Prawn::Document::Internal#names). This name tree is used to store named
+      # embedded files (PDF spec 3.10.3). (For more on name trees, see section
+      # 3.8.4 in the PDF spec.)
+      #
+      def embedded_files
+        bump_min_version
+
+        names.data[:EmbeddedFiles] ||= ref!(
+          PDF::Core::NameTree::Node.new(self, NAME_TREE_CHILDREN_LIMIT)
+        )
+      end
+
+      # Adds a new embedded file to the EmbeddedFiles name tree
+      # (see #embedded_files). The +reference+ parameter will be converted into
+      # a PDF::Core::Reference if it is not already one.
+      #
+      def add_embedded_file(name, reference)
+        reference = ref!(reference) unless reference.is_a?(PDF::Core::Reference)
+        embedded_files.data.add(name, reference)
+      end
+
+      # Friendly method alias to attach file specifications in the catalog
+      alias attach_file add_embedded_file
+
+      private
+
+      def bump_min_version
+        renderer.min_version(1.4)
+      end
+    end
+  end
+end

data/lib/prawn/attachment/embedded_file.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Prawn
+  module Attachment
+    # EmbeddedFile represents a file to be embedded in the PDF.
+    class EmbeddedFile
+      attr_reader :data, :creation_date, :modification_date, :checksum
+
+      def initialize(data, options = {})
+        @data = data
+
+        @creation_date = options[:creation_date]
+        @creation_date = Time.now.utc unless @creation_date.is_a?(Time)
+
+        @modification_date = options[:modification_date]
+        @modification_date = Time.now.utc unless @modification_date.is_a?(Time)
+
+        @checksum = Digest::MD5.digest(data)
+      end
+
+      def build_pdf_object(document)
+        obj = document.ref!(reference_params)
+        obj << data
+        obj.stream.compress! if document.compression_enabled?
+        obj
+      end
+
+      private
+
+      def reference_params
+        {
+          Type: :EmbeddedFile,
+          Params: {
+            CreationDate: creation_date,
+            ModDate: modification_date,
+            CheckSum: PDF::Core::LiteralString.new(checksum),
+            Size: data.length
+          }
+        }
+      end
+    end
+  end
+end

data/lib/prawn/attachment/filespec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Prawn
+  module Attachment
+    # FileSpec corresponds to the PDF file specification object.
+    class Filespec
+      attr_reader :file_name
+
+      def initialize(file, options = {})
+        hexdigest = Digest.hexencode(file.data[:Params][:CheckSum])
+        name = options[:name] || hexdigest
+
+        @file_name = PDF::Core::LiteralString.new(name)
+
+        if options[:description]
+          desc_str = options[:description].to_s
+          @description = PDF::Core::LiteralString.new(desc_str)
+        end
+
+        @hidden = options[:hidden]
+        @file = file
+      end
+
+      def hidden?
+        @hidden
+      end
+
+      def build_pdf_object(document)
+        obj = document.ref!(
+          Type: :Filespec,
+          F: file_name,
+          EF: { F: file, UF: file },
+          UF: file_name
+        )
+
+        obj.data[:Desc] = description if description
+        obj
+      end
+
+      private
+
+      attr_reader :file, :description
+    end
+  end
+end

data/lib/prawn/attachment/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Prawn
+  module Attachment
+    VERSION = "0.2.0"
+  end
+end

data/lib/prawn/attachment.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "prawn"
+require_relative "../pdf/core/embedded_files"
+
+require_relative "attachment/version"
+require_relative "attachment/embedded_file"
+require_relative "attachment/filespec"
+
+module Prawn
+  # Module that supports attachment of file data into a Prawn::Document
+  module Attachment
+    include PDF::Core::EmbeddedFiles
+
+    # Missing data error
+    class NoDataError < StandardError
+      def message
+        "Source data is empty"
+      end
+    end
+
+    # Attach a file's data to the document. File IO Objects are expected.
+    #
+    # Arguments:
+    # <tt>name</tt>:: name of attachment.
+    # <tt>src</tt>:: String or IO object containing source file data.
+    #
+    # Options:
+    # <tt>:created_at</tt>:: timestamp when the file was created.
+    # <tt>:modified_at</tt>::  timestamp for when file was last modified.
+    # <tt>:description</tt>:: file description.
+    # <tt>:hidden</tt>:: if true, prevents the file from appearing in the
+    # catalog. (default false)
+    #
+    #   Prawn::Document.generate("file1.pdf") do
+    #     path = "#{Prawn::DATADIR}/images/dice.png"
+    #     attach "dice.png", File.open(path), description: 'Example of an attached image file'
+    #   end
+    #
+    # This method returns an instance of PDF::Core::NameTree::Value
+    # corresponding to the file in the attached files catalog entry node. If
+    # hidden, then nil is returned.
+    #
+    def attach(name, src, opts = {})
+      data = src.is_a?(IO) ? src.read : src.b
+      raise NoDataError if data.length.zero?
+
+      opts = prepare_options(name, opts)
+
+      # Prepare embeddable representation of the source data
+      file = EmbeddedFile.new(data, opts)
+
+      filespec = Filespec.new(file_obj_from_registry(file), opts)
+      filespec_obj = filespec.build_pdf_object(self)
+
+      attach_file(filespec.file_name, filespec_obj) unless filespec.hidden?
+    end
+
+    private
+
+    def prepare_options(name, opts)
+      {
+        name: name,
+        creation_date: opts[:created_at] || Time.now.utc,
+        modification_date: opts[:modified_at] || Time.now.utc,
+        description: opts[:description],
+        hidden: !!opts[:hidden]
+      }
+    end
+
+    # attempt to find a previously stored version of the embedded file in the
+    # registry, just in case the same file is attached twice with different names.
+    def file_obj_from_registry(file)
+      file_obj = file_registry[file.checksum]
+      return file_obj if file_obj
+
+      file_obj = file.build_pdf_object(self)
+      file_registry[file.checksum] = file_obj
+      file_obj
+    end
+
+    def file_registry
+      @file_registry ||= {}
+    end
+  end
+end
+
+# Add ourselves to prawn
+Prawn::Document.include Prawn::Attachment

data/prawn-attachment.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/prawn/attachment/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prawn-attachment"
+  spec.version       = Prawn::Attachment::VERSION
+  spec.authors       = ["David Lilue", "Sam Lown"]
+  spec.email         = ["david.lilue@invopop.com", "sam.lown@invopop.com"]
+
+  spec.summary       = "Attach files to Prawn generated PDFs according to PDF/A-3"
+  spec.homepage      = "https://github.com/invopop/prawn-attachment"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/invopop/prawn-attachment"
+  spec.metadata["changelog_uri"] = "https://github.com/invopop/prawn-attachment"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "prawn", "~> 2.4.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: prawn-attachment
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- David Lilue
+- Sam Lown
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: 
+email:
+- david.lilue@invopop.com
+- sam.lown@invopop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/attach.rb
+- example/data.json
+- lib/pdf/core/embedded_files.rb
+- lib/prawn/attachment.rb
+- lib/prawn/attachment/embedded_file.rb
+- lib/prawn/attachment/filespec.rb
+- lib/prawn/attachment/version.rb
+- prawn-attachment.gemspec
+homepage: https://github.com/invopop/prawn-attachment
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/invopop/prawn-attachment
+  source_code_uri: https://github.com/invopop/prawn-attachment
+  changelog_uri: https://github.com/invopop/prawn-attachment
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Attach files to Prawn generated PDFs according to PDF/A-3
+test_files: []