hexapdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c10b3600c81488af01c877e24fc31aa859968e8
+  data.tar.gz: 6bdde619dae45921219a100612fd67e3fd1e1317
+SHA512:
+  metadata.gz: 9b79e62cf749a111b4a81a6ce7dab39dfca4b66ba47cd9961ab7452fb75a75373bb01a088659d7bca31429969341b980e75a3a39008525effb2bd116d0162a69
+  data.tar.gz: b09a691c6f92f6035a73f226ec0d566f2d48a18082478a03037ea4dd0dded3698d25a0e403aa7f51cea8d9481bafd923f8de8d9510a961994c0f5e733aa12bbf

data/CONTRIBUTERS

@@ -0,0 +1,3 @@
+  Count Name
+======= ====
+    601 Thomas Leitner <t_leitner@gmx.at>

data/LICENSE

@@ -0,0 +1,26 @@
+HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+Copyright (C) 2016 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.

data/README.md

@@ -0,0 +1,88 @@
+# 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_page.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.
+
+[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.3 or
+higher as prior versions are not (officially) supported!
+
+Apart from Ruby itself the HexaPDF library has no external dependencies. The `hexapdf` application
+has a 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
+
+[Prawn] is a Ruby library that can be used for creating PDF files. It has been in development since
+2008 and currently provides more features in regard to PDF content creation than HexaPDF.
+
+So why use HexaPDF? Because it differs significantly from Prawn in how it is implemented:
+
+* 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.
+
+[Prawn]: http://prawnpdf.org
+
+
+## License
+
+See the LICENSE file for licensing details.
+
+
+## Contributing
+
+See <http://hexapdf.gettalong.org/contributing.html> for more information.
+
+
+## Author
+
+Thomas Leitner, <http://gettalong.org>

data/Rakefile

@@ -0,0 +1,121 @@
+require 'rake/testtask'
+require 'rake/clean'
+require 'rubygems/package_task'
+
+$:.unshift('lib')
+require 'hexapdf'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*.rb']
+  t.verbose = false
+  t.warning = true
+end
+
+namespace :dev do
+  PKG_FILES = FileList.new([
+    'Rakefile',
+    'LICENSE', 'agpl-3.0.txt',
+    'README.md',
+    'VERSION', 'CONTRIBUTERS',
+    'bin/*',
+    'lib/**/*.rb',
+    'man/man1/hexapdf.1',
+    'data/**/*',
+    'examples/*',
+    'test/**/*'
+  ])
+
+  CLOBBER << "man/man1/hexapdf.1"
+  file 'man/man1/hexapdf.1' => ['man/man1/hexapdf.1.md'] do
+    puts "Generating hexapdf man page"
+    system "ronn --pipe -r 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
+
+  spec = Gem::Specification.new do |s|
+    s.name = 'hexapdf'
+    s.version = HexaPDF::VERSION
+    s.summary = "HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby"
+    s.description = "HexaPDF is a pure Ruby library with an accompanying application for " \
+      "working with PDF files.\n\nIn 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.\n\nHexaPDF 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."
+    s.license = 'AGPL-3.0'
+
+    s.files = PKG_FILES.to_a
+
+    s.require_path = 'lib'
+    s.executables = ['hexapdf']
+    s.default_executable = 'hexapdf'
+    s.add_dependency('cmdparse', '~> 3.0', '>= 3.0.1')
+    s.add_development_dependency('ronn', '~> 0.7')
+
+    s.author = 'Thomas Leitner'
+    s.email = 't_leitner@gmx.at'
+    s.homepage = "http://hexapdf.gettalong.org"
+  end
+
+  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]
+
+  CLOBBER << 'hexapdf.gemspec'
+  task :gemspec do
+    puts "Generating Gemspec"
+    contents = spec.to_ruby
+    File.open("hexapdf.gemspec", 'w+') {|f| f.puts(contents)}
+  end
+
+  CODING_LINE = "# -*- encoding: utf-8 -*-\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'

data/VERSION

@@ -0,0 +1 @@
+0.1.0