hexapdf 0.17.1 → 0.17.2

data/LICENSE

@@ -0,0 +1,29 @@
+HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+Copyright (C) 2014-2021 Thomas Leitner
+
+HexaPDF is free software: you can redistribute it and/or modify it
+under the terms of the GNU Affero General Public License version 3 as
+published by the Free Software Foundation with the addition of the
+following permission added to Section 15 as permitted in Section 7(a):
+FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+INFRINGEMENT OF THIRD PARTY RIGHTS.
+
+HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+
+The interactive user interfaces in modified source and object code
+versions of HexaPDF must display Appropriate Legal Notices, as required
+under Section 5 of the GNU Affero General Public License version 3.
+
+In accordance with Section 7(b) of the GNU Affero General Public
+License, a covered work must retain the producer line in every PDF that
+is created or manipulated using HexaPDF.
+
+If the GNU Affero General Public License doesn't fit your need,
+commercial licenses are available at <https://gettalong.at/hexapdf/>.

data/README.md

@@ -0,0 +1,129 @@
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+
+HexaPDF is a pure Ruby library with an accompanying application for working with PDF files. In
+short, it allows
+
+* **creating** new PDF files,
+* **manipulating** existing PDF files,
+* **merging** multiple PDF files into one,
+* **extracting** meta information, text, images and files from PDF files,
+* **securing** PDF files by encrypting them and
+* **optimizing** PDF files for smaller file size or other criteria.
+
+HexaPDF was designed with ease of use and performance in mind. It uses lazy loading and lazy
+computing when possible and tries to produce small PDF files by default.
+
+
+## Usage
+
+The HexaPDF distribution provides the library as well as the `hexapdf` application. The application
+can be used to perform common tasks like merging PDF files, decrypting or encrypting PDF files and
+so on.
+
+When HexaPDF is used as a library, it can be used to do all the task that the command line
+application does and much more. Here is a "Hello World" example that shows how to create a simple
+PDF file:
+
+~~~ ruby
+require 'hexapdf'
+
+doc = HexaPDF::Document.new
+canvas = doc.pages.add.canvas
+canvas.font('Helvetica', size: 100)
+canvas.text("Hello World!", at: [20, 400])
+doc.write("hello-world.pdf")
+~~~
+
+For detailed information have a look at the [HexaPDF website][website] where you will the API
+documentation, example code and more.
+
+It is recommend to use the HTML API documentation provided by the HexaPDF website as it is enhanced
+with example graphics and PDF files and tightly integrated into the rest of the website.
+
+[website]: http://hexapdf.gettalong.org
+
+
+## Requirements and Installation
+
+Since HexaPDF is written in Ruby, a working Ruby installation is needed - see the
+[official installation documentation][rbinstall] for details. Note that you need Ruby version 2.4 or
+higher as prior versions are not supported!
+
+Apart from Ruby itself the HexaPDF library has only one external dependency `geom2d` which is
+written and provided by the HexaPDF authors. The `hexapdf` application has an additional dependency
+on `cmdparse`, a command line parsing library.
+
+HexaPDF itself is distributed via Rubygems and therefore easily installable via `gem install
+hexapdf`.
+
+[rbinstall]: https://www.ruby-lang.org/en/documentation/installation/
+
+
+## Difference to Prawn
+
+The main difference between HexaPDF and [Prawn] is that HexaPDF is a **full PDF library** whereas
+Prawn is a **library for generating content**.
+
+To be more specific, it is easily possible to read an existing PDF with HexaPDF and modify parts of
+it before writing it out again. The modifications can be to the PDF object structure like removing
+superfluous annotations or the the content itself.
+
+Prawn has no such functionality. There is basic support for using a PDF as a template using the
+`pdf-reader` and `prawn-template` gems but support is very limited. However, Prawn has a very
+featureful API when it comes to creating content, for individual pages as well as across pages.
+
+Such functionality will be incorporated into HexaPDF in the near future. The main functionality for
+providing such a feature is already available in HexaPDF (the [page canvas API]). Additionally,
+laying out text inside a box with line wrapping and such is also supported. What's missing (and this
+is still quite a big chunk) is support for advanced features like tables, page breaking and so on.
+
+So why use HexaPDF?
+
+* The architecture of HexaPDF is based on the object model of the PDF standard. This makes extending
+  HexaPDF very easy and allows for **reading PDF files for templating purposes**.
+
+* HexaPDF will provide a high level layer for **composing a document of individual elements** that
+  are automatically layouted. Such elements can be headers, paragraphs, code blocks, ... or links,
+  emphasized text and so on. These elements can be customized and additional element types easily
+  added.
+
+* In addition to being usable as a library, HexaPDF also comes with a command line tool for
+  manipulating PDFs. This tool is intended to be a replacement for tools like `pdftk` and the
+  various Poppler-based tools like `pdfinfo`, `pdfimages`, ...
+
+[Prawn]: http://prawnpdf.org
+[page canvas API]: https://hexapdf.gettalong.org/api/HexaPDF/Content/Canvas.html
+
+## Development
+
+Clone the repository and then run `rake dev:setup`. This will install the needed Rubygem
+dependencies as well as make sure that all applications needed for the tests are available.
+
+
+## License
+
+AGPL - see the LICENSE file for licensing details. Commercial licenses are available at
+<https://gettalong.at/hexapdf/>.
+
+Some included files have a different license:
+
+* For the license of the included AFM files in the `data/hexapdf/afm` directory, see the file
+  `data/hexapdf/afm/MustRead.html`.
+
+* The files `test/data/encoding/{glyphlist.txt,zapfdingbats.txt}` are licensed under the Apache
+  License V2.0.
+
+* The file `test/data/fonts/Ubuntu-Title.ttf` is licensed under the SIL Open Font License.
+
+* The AES test vector files in `test/data/aes-test-vectors` have been created using the test vector
+  file available from <http://csrc.nist.gov/groups/STM/cavp/block-ciphers.html#test-vectors>.
+
+
+## Contributing
+
+See <http://hexapdf.gettalong.org/contributing.html> for more information.
+
+
+## Author
+
+Thomas Leitner, <http://gettalong.org>

data/Rakefile

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+require 'rake/testtask'
+require 'rake/clean'
+require 'rubygems/package_task'
+
+require_relative 'lib/hexapdf/version'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*.rb']
+  t.verbose = false
+  t.warning = true
+end
+
+namespace :dev do
+  CLOBBER << "man/man1/hexapdf.1"
+  file 'man/man1/hexapdf.1' => ['man/man1/hexapdf.1.md'] do
+    puts "Generating hexapdf man page"
+    system "kramdown -o man man/man1/hexapdf.1.md > man/man1/hexapdf.1"
+  end
+
+  CLOBBER << "VERSION"
+  file 'VERSION' do
+    puts "Generating VERSION file"
+    File.open('VERSION', 'w+') {|file| file.write(HexaPDF::VERSION + "\n") }
+  end
+
+  CLOBBER << 'CONTRIBUTERS'
+  file 'CONTRIBUTERS' do
+    puts "Generating CONTRIBUTERS file"
+    `echo "  Count Name" > CONTRIBUTERS`
+    `echo "======= ====" >> CONTRIBUTERS`
+    `git log | grep ^Author: | sed 's/^Author: //' | sort | uniq -c | sort -nr >> CONTRIBUTERS`
+  end
+
+  ENV['REAL_GEM'] = "true"
+  spec = eval(File.read('hexapdf.gemspec'), binding, 'hexapdf.gemspec')
+  Gem::PackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+
+  desc "Upload the release to Rubygems"
+  task publish_files: [:package] do
+    sh "gem push pkg/hexapdf-#{HexaPDF::VERSION}.gem"
+    puts 'done'
+  end
+
+  desc 'Release HexaPDF version ' + HexaPDF::VERSION
+  task release: [:clobber, :package, :publish_files]
+
+  desc "Set-up everything for development"
+  task :setup do
+    puts "Installing required runtime and development gems:"
+    resolver = Gem::Resolver.for_current_gems(spec.dependencies)
+    resolver.ignore_dependencies = true
+    resolver.soft_missing = true
+    resolver.resolve
+    spec.dependencies.each do |dependency|
+      if resolver.missing.find {|dep_request| dep_request.dependency == dependency }
+        print "✗ #{dependency.name} - installing it..."
+        Gem.install(dependency.name, dependency.requirement, prerelease: true)
+        puts " done"
+      else
+        puts "✓ #{dependency.name}"
+      end
+    end
+
+    puts
+    puts "The following binaries are needed for the tests:"
+    {
+      'pngtopnm' => 'sudo apt install netpbm',
+      'pngcheck' => 'sudo apt install pngcheck',
+    }.each do |name, install_command|
+      `which #{name} 2>&1`
+      if $?.exitstatus == 0
+        puts "✓ #{name}"
+      else
+        puts "✗ #{name} (#{install_command})"
+      end
+    end
+  end
+
+  CODING_LINE = "# -*- encoding: utf-8; frozen_string_literal: true -*-\n"
+
+  desc "Insert/Update copyright notice"
+  task :update_copyright do
+    license = File.readlines(File.join(__dir__, 'LICENSE')).map do |l|
+      l.strip.empty? ? "#\n" : "# #{l}"
+    end.join
+    statement = CODING_LINE + "#\n#--\n# This file is part of HexaPDF.\n#\n" + license + "#++\n"
+    inserted = false
+    Dir["lib/**/*.rb"].each do |file|
+      unless File.read(file).start_with?(statement)
+        inserted = true
+        puts "Updating file #{file}"
+        old = File.read(file)
+        unless old.gsub!(/\A#{Regexp.escape(CODING_LINE)}#\n#--.*?\n#\+\+\n/m, statement)
+          old.gsub!(/\A(#{Regexp.escape(CODING_LINE)})?/, statement)
+        end
+        File.write(file, old)
+      end
+    end
+    puts "Look through the above mentioned files and correct all problems" if inserted
+  end
+end
+
+task clobber: 'dev:clobber'
+task default: 'test'