dragonfly_pdf 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc1dfc0957a54f9a471a6f47705706ec438af938
-  data.tar.gz: 2c83a13ad1d7f2cf1b5f4263d01c04fbad9ce770
+  metadata.gz: b630259edd321fc3a4972fc7c5cae40871e050b0
+  data.tar.gz: 57b09a13cd2c1b4099a56d284519873e792b0fc7
 SHA512:
-  metadata.gz: 28ca7db1d884b7ac8e79ce28ae7e18aecb5e1c08d4080ba4c8f03e09055aec5fa13ccfb6b7cd49a7f50d14dbfb585e7eb7134621607a90b3a4891057edee6b68
-  data.tar.gz: f8108c9aedbac45adea7d5a74ac96e924f0ddafa72db667b90acffafd577379823bd1c4a2dd175edb39b29de42da09eda17c246772718ecd6f528d50bd506e88
+  metadata.gz: 2185816838240ea29832527c758e9648a37038bdbd8f8d893eef372dd33941820730ebbe3faa1d7d082b47494ff9b1e563bddf2d5e11cadd4e414a0198233520
+  data.tar.gz: 52a19c0bddb5ce97f81a57ceb43f5e369b34343034af72b3af770b314303286318f21177d6bad56240cfe2cd5649ea40a9dec61c96220e9ceade68fd182c8ad1

data/.travis.yml

@@ -1,10 +1,15 @@
 language: ruby
 cache: bundler
 script: 'bundle exec rake'
+sudo: required
+dist: trusty
 rvm:
   - 2.1.2
 before_install:
   - gem update bundler
+  - sudo apt-get update
+  - sudo apt-get install -y pdftk
+  - pdftk --version
 notifications:
   email:
     recipients:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0
+
+* refactor: read PDF attributes directly
+* dependency: `pdftk` for adjustments to PDFs
+* added: `append` to combine multiple PDFs together
+* added: `rotate` to rotate pages of a PDF
+* added: `stamp` to stamping pages with content of another PDF
+
 ## 0.1.0
 
 * added: `page_dimensions`

data/README.md

@@ -8,6 +8,7 @@
 
 * [ImageMagick](http://www.imagemagick.org)
 * [GhostScript](http://www.ghostscript.com)
+* [pdftk](https://www.pdflabs.com/tools/pdftk-server)
 
 ## Installation
 
@@ -39,13 +40,7 @@ end
 Reads properties from a PDF.
 
 ```ruby
-pdf.pdf_properties
-```
-
-It returns a hash of properties:
-
-```ruby
-{
+pdf.pdf_properties # => {
     page_count: 4,
     page_dimensions: [[210.0, 297.0], [210.0, 297.0], [210.0, 297.0], [210.0, 297.0]],
     page_numbers: [1, 2, 3, 4],
@@ -55,8 +50,24 @@ It returns a hash of properties:
 }
 ```
 
+Optionally pass box type (`MediaBox|CropBox|BleedBox|TrimBox`):
+
+```ruby
+pdf.pdf_properties(box_type: 'MediaBox')
+```
+
+By default `TrimBox`, with a fallback to `MediaBox`.
+
 ## Processors
 
+### Append
+
+Append PDFs.
+
+```ruby
+pdf.append([pdf_1, pdf_2, pdf_3])
+```
+
 ### Page
 
 Extracts page from PDF.
@@ -82,6 +93,30 @@ The available options and their default values are:
 }
 ```
 
+### Rotate
+
+Rotate all pages.
+
+```ruby
+pdf.rotate(:left)
+```
+
+Rotate selected pages.
+```ruby
+pdf.rotate(1 => :left, 3 => :right)
+```
+
+absolute: `north|south|east|west`
+relative: `left|right|down`
+
+### Stamp
+
+Stamp every page of a PDF with another PDF.
+
+```ruby
+pdf.stamp(stamp_pdf)
+```
+
 ### Subset Fonts
 
 Subset fonts in PDF.

data/dragonfly_pdf.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "dragonfly", "~> 1.0"
 
-  spec.add_development_dependency "pdf-reader"
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pdf-reader"
+  spec.add_development_dependency "rake"
 end

data/lib/dragonfly_pdf/analysers/pdf_properties.rb

@@ -2,68 +2,39 @@ module DragonflyPdf
   module Analysers
     class PdfProperties
       def call(content, options = {})
-        @content = content
-        @use_cropbox = options.fetch :use_cropbox, true
-        @use_trimbox = options.fetch :use_trimbox, true
-        @page_dimensions = page_dimensions
-        {
-          aspect_ratios: aspect_ratios,
-          heights: heights,
-          page_count: page_count,
-          page_dimensions: @page_dimensions,
-          page_numbers: page_numbers,
-          widths: widths
-        }
-      end
-
-      private # =============================================================
-
-      def page_dimensions
-        res = @content.shell_eval do |path|
-          "#{identify_command} -format '%Wx%H,' #{path}"
-        end
-        res.to_s.split(/\s*,\s*/).compact.map do |page|
-          page = page.split(/\s*x\s*/).map(&:to_f).map { |n| pt2mm(n) }
-        end
-      end
-
-      # ---------------------------------------------------------------------
+        box_type = options.fetch :box_type, 'TrimBox'
 
-      def widths
-        @page_dimensions.inject([]) do |res, page|
-          res << page[0]
+        box_data = []
+        IO.foreach(content.path, "\n\n", encoding: "ISO-8859-1") do |item|
+          box_data += item.scan(/(MediaBox|CropBox|BleedBox|TrimBox)\s?\[([\d\.]+?)\s([\d\.]+?)\s([\d\.]+?)\s([\d\.]+?)\]/)
         end
-      end
 
-      def heights
-        @page_dimensions.inject([]) do |res, page|
-          res << page[1]
-        end
-      end
+        # drop last value, since that comes from data about all pages
+        media_box = box_data.select { |d| d.first == 'MediaBox' }[0..-2]
+        desired_box = box_data.select { |d| d.first == box_type }
 
-      def aspect_ratios
-        @page_dimensions.inject([]) do |res, page|
-          res << page[0] / page[1]
+        page_dimensions = (desired_box.length > 0 ? desired_box : media_box).map do |dim|
+          i = dim[1..-1].map(&:to_f).map{ |d| pt2mm(d) }
+          [ i[2]-i[0], i[3]-i[1] ]
         end
-      end
 
-      def page_count
-        @page_dimensions.count
-      end
+        page_count = page_dimensions.count
+        aspect_ratios = page_dimensions.inject([]) { |res, page| res << (page.first / page.last) }
+        page_numbers = (1..page_count).to_a
 
-      def page_numbers
-        (1..page_count).to_a
+        {
+          aspect_ratios: aspect_ratios,
+          page_count: page_count,
+          page_dimensions: page_dimensions,
+          page_numbers: page_numbers
+        }
       end
 
-      # =====================================================================
+      private # =============================================================
 
       def pt2mm(pt)
         (pt / 72.0) * 25.4
       end
-
-      def identify_command
-        "identify -define pdf:use-cropbox=#{@use_cropbox} -define pdf:use-trimbox=#{@use_trimbox}"
-      end
     end
   end
 end

data/lib/dragonfly_pdf/plugin.rb

@@ -1,11 +1,14 @@
 require 'dragonfly_pdf/analysers/pdf_properties'
+require 'dragonfly_pdf/processors/append'
 require 'dragonfly_pdf/processors/page'
 require 'dragonfly_pdf/processors/page_thumb'
+require 'dragonfly_pdf/processors/rotate'
+require 'dragonfly_pdf/processors/stamp'
 require 'dragonfly_pdf/processors/subset_fonts'
 
 module DragonflyPdf
   class Plugin
-    def call app, opts={}
+    def call(app, _opts = {})
       app.add_analyser :pdf_properties, DragonflyPdf::Analysers::PdfProperties.new
 
       app.add_analyser :page_count do |content|
@@ -34,8 +37,11 @@ module DragonflyPdf
 
       # ---------------------------------------------------------------------
 
-      app.add_processor :page_thumb, DragonflyPdf::Processors::PageThumb.new
+      app.add_processor :append, DragonflyPdf::Processors::Append.new
       app.add_processor :page, DragonflyPdf::Processors::Page.new
+      app.add_processor :page_thumb, DragonflyPdf::Processors::PageThumb.new
+      app.add_processor :rotate, DragonflyPdf::Processors::Rotate.new
+      app.add_processor :stamp, DragonflyPdf::Processors::Stamp.new
       app.add_processor :subset_fonts, DragonflyPdf::Processors::SubsetFonts.new
     end
   end

data/lib/dragonfly_pdf/processors/append.rb

@@ -0,0 +1,17 @@
+module DragonflyPdf
+  module Processors
+    class Append
+      def call(content, pdfs_to_append, _options = {})
+        content.shell_update(ext: :pdf) do |old_path, new_path|
+          "#{pdftk_command} #{old_path} #{pdfs_to_append.map(&:path).join(' ')} cat output #{new_path}"
+        end
+      end
+
+      private # =============================================================
+
+      def pdftk_command
+        "pdftk"
+      end
+    end
+  end
+end

data/lib/dragonfly_pdf/processors/page.rb

@@ -5,13 +5,11 @@ module DragonflyPdf
   module Processors
     class Page
       def call(content, page_number = 1, _opts = {})
-        @content = content
-        @page_number = page_number
-
+        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content)
         fail DragonflyPdf::PageNotFound unless pdf_properties[:page_numbers].include?(page_number)
 
-        @content.shell_update(ext: :pdf) do |old_path, new_path|
-          "#{gs_command} -dFirstPage=#{@page_number} -dLastPage=#{@page_number} -o #{new_path} -f #{old_path}"
+        content.shell_update(ext: :pdf) do |old_path, new_path|
+          "#{gs_command} -dFirstPage=#{page_number} -dLastPage=#{page_number} -o #{new_path} -f #{old_path}"
         end
       end
 
@@ -20,10 +18,6 @@ module DragonflyPdf
       def gs_command
         'gs -sDEVICE=pdfwrite -dNOPAUSE -dBATCH'
       end
-
-      def pdf_properties
-        @pdf_properties ||= DragonflyPdf::Analysers::PdfProperties.new.call(@content)
-      end
     end
   end
 end

data/lib/dragonfly_pdf/processors/rotate.rb

@@ -0,0 +1,26 @@
+module DragonflyPdf
+  module Processors
+    class Rotate
+      def call(content, arg)
+        rotate_args = case arg
+                      when String, Symbol
+                        fail ArgumentError.new unless arg =~ /north|south|east|west|left|right|down/i
+                        "1-end#{arg}"
+                      when Hash
+                        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content)
+                        pdf_properties[:page_numbers].map { |page| [page, arg[page]].compact.join }.join(' ')
+        end
+
+        content.shell_update(ext: :pdf) do |old_path, new_path|
+          "#{pdftk_command} #{old_path} cat #{rotate_args} output #{new_path}"
+        end
+      end
+
+      private # =============================================================
+
+      def pdftk_command
+        'pdftk'
+      end
+    end
+  end
+end

data/lib/dragonfly_pdf/processors/stamp.rb

@@ -0,0 +1,17 @@
+module DragonflyPdf
+  module Processors
+    class Stamp
+      def call(content, stamp_pdf, _options = {})
+        content.shell_update(ext: :pdf) do |old_path, new_path|
+          "#{pdftk_command} #{old_path} stamp #{stamp_pdf.path} output #{new_path}"
+        end
+      end
+
+      private # =============================================================
+
+      def pdftk_command
+        "pdftk"
+      end
+    end
+  end
+end

data/lib/dragonfly_pdf/version.rb

@@ -1,3 +1,3 @@
 module DragonflyPdf
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/test/dragonfly_pdf/analysers/pdf_properties_test.rb

@@ -27,26 +27,12 @@ module DragonflyPdf
       end
 
       describe '#page_dimensions' do
-        it 'returns widths' do
+        it 'returns array of page dimensions' do
           analyser.call(sample_pages)[:page_dimensions].map{ |p| p.map(&:round) }.must_equal [[210, 297]].cycle.take(10)
           analyser.call(sample_pages_with_bleed)[:page_dimensions].map{ |p| p.map(&:round) }.must_equal [[210, 297]].cycle.take(1)
         end
       end
 
-      describe '#widths' do
-        it 'returns widths' do
-          analyser.call(sample_pages)[:widths].map(&:round).must_equal [210].cycle.take(10)
-          analyser.call(sample_pages_with_bleed)[:widths].map(&:round).must_equal [210].cycle.take(1)
-        end
-      end
-
-      describe '#heights' do
-        it 'returns heights' do
-          analyser.call(sample_pages)[:heights].map(&:round).must_equal [297].cycle.take(10)
-          analyser.call(sample_pages_with_bleed)[:heights].map(&:round).must_equal [297].cycle.take(1)
-        end
-      end
-
       describe '#aspect_ratios' do
         it 'returns aspect ratios' do
           analyser.call(sample_pages)[:aspect_ratios].map{ |i| i.round(2) }.must_equal [0.71].cycle.take(10)

data/test/dragonfly_pdf/processors/append_test.rb

@@ -0,0 +1,34 @@
+require 'pdf-reader'
+require 'test_helper'
+
+module DragonflyPdf
+  module Processors
+    describe Append do
+      let(:app) { test_app.configure_with(:pdf) }
+      let(:processor) { DragonflyPdf::Processors::Append.new }
+      let(:sample_1) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_pages.pdf')) }
+      let(:sample_2) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_pages_with_bleed.pdf')) }
+      let(:result) { PDF::Reader.new(sample_1.path) }
+
+      # =====================================================================
+
+      before do
+        processor.call(sample_1, [sample_2])
+      end
+
+      it 'returns PDF by default' do
+        get_mime_type(sample_1.path).must_include 'application/pdf'
+      end
+
+      it 'has total number of pages' do
+        result.pages.count.must_equal 11
+      end
+
+      # ---------------------------------------------------------------------
+
+      def get_mime_type(file_path)
+        `file --mime-type #{file_path}`.gsub(/\n/, '')
+      end
+    end
+  end
+end

data/test/dragonfly_pdf/processors/page_test.rb

@@ -1,3 +1,4 @@
+require 'pdf-reader'
 require 'test_helper'
 
 module DragonflyPdf
@@ -6,6 +7,7 @@ module DragonflyPdf
       let(:app) { test_app.configure_with(:pdf) }
       let(:processor) { DragonflyPdf::Processors::Page.new }
       let(:sample_pages) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_pages.pdf')) }
+      let(:result) { PDF::Reader.new(sample_pages.path) }
 
       # =====================================================================
 
@@ -22,9 +24,8 @@ module DragonflyPdf
       describe 'single pages' do
         it 'renders page' do
           processor.call(sample_pages, 1)
-          pdf = PDF::Reader.new(sample_pages.path)
-          pdf.pages.count.must_equal 1
-          pdf.pages.first.text.must_equal '1'
+          result.pages.count.must_equal 1
+          result.pages.first.text.must_equal '1'
         end
       end
 

data/test/dragonfly_pdf/processors/rotate_test.rb

@@ -0,0 +1,40 @@
+require 'pdf-reader'
+require 'test_helper'
+
+module DragonflyPdf
+  module Processors
+    describe Rotate do
+      let(:app) { test_app.configure_with(:pdf) }
+      let(:processor) { DragonflyPdf::Processors::Rotate.new }
+      let(:sample_1) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_pages.pdf')) }
+      let(:result) { PDF::Reader.new(sample_1.path) }
+
+      # =====================================================================
+
+      it 'returns PDF by default' do
+        processor.call(sample_1, :left)
+        get_mime_type(sample_1.path).must_include 'application/pdf'
+      end
+
+      describe 'arg is String|Symbol' do
+        it 'rotates all pages' do
+          processor.call(sample_1, :left)
+          result.pages.map { |p| p.attributes[:Rotate] }.must_equal [270, 270, 270, 270, 270, 270, 270, 270, 270, 270]
+        end
+      end
+
+      describe 'arg is Hash' do
+        it 'rotates only defined pages' do
+          processor.call(sample_1, 1 => :left, 3 => :right)
+          result.pages.map { |p| p.attributes[:Rotate] }.must_equal [270, nil, 90, nil, nil, nil, nil, nil, nil, nil]
+        end
+      end
+
+      # ---------------------------------------------------------------------
+
+      def get_mime_type(file_path)
+        `file --mime-type #{file_path}`.gsub(/\n/, '')
+      end
+    end
+  end
+end

data/test/dragonfly_pdf/processors/stamp_test.rb

@@ -0,0 +1,38 @@
+require 'pdf-reader'
+require 'test_helper'
+
+module DragonflyPdf
+  module Processors
+    describe Stamp do
+      let(:app) { test_app.configure_with(:pdf) }
+      let(:processor) { DragonflyPdf::Processors::Stamp.new }
+      let(:sample_1) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_pages.pdf')) }
+      let(:sample_stamp) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_stamp.pdf')) }
+      let(:result) { PDF::Reader.new(sample_1.path) }
+
+      # =====================================================================
+
+      before do
+        processor.call(sample_1, sample_stamp)
+      end
+
+      it 'returns PDF by default' do
+        get_mime_type(sample_1.path).must_include 'application/pdf'
+      end
+
+      it 'has same number of pages' do
+        result.pages.count.must_equal 10
+      end
+
+      it 'has the stamp' do
+        result.pages.map(&:text).must_equal %w(STAMP).cycle(10).to_a
+      end
+
+      # ---------------------------------------------------------------------
+
+      def get_mime_type(file_path)
+        `file --mime-type #{file_path}`.gsub(/\n/, '')
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -7,8 +7,6 @@ require 'minitest/spec'
 require 'dragonfly'
 require 'dragonfly_pdf'
 
-require 'pdf-reader'
-
 # ---------------------------------------------------------------------
 
 SAMPLES_DIR = Pathname.new(File.expand_path('../../samples', __FILE__))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: pdf-reader
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -128,16 +128,23 @@ files:
 - lib/dragonfly_pdf/analysers/pdf_properties.rb
 - lib/dragonfly_pdf/errors.rb
 - lib/dragonfly_pdf/plugin.rb
+- lib/dragonfly_pdf/processors/append.rb
 - lib/dragonfly_pdf/processors/page.rb
 - lib/dragonfly_pdf/processors/page_thumb.rb
+- lib/dragonfly_pdf/processors/rotate.rb
+- lib/dragonfly_pdf/processors/stamp.rb
 - lib/dragonfly_pdf/processors/subset_fonts.rb
 - lib/dragonfly_pdf/version.rb
 - samples/sample_pages.pdf
 - samples/sample_pages_with_bleed.pdf
+- samples/sample_stamp.pdf
 - test/dragonfly_pdf/analysers/pdf_properties_test.rb
 - test/dragonfly_pdf/plugin_test.rb
+- test/dragonfly_pdf/processors/append_test.rb
 - test/dragonfly_pdf/processors/page_test.rb
 - test/dragonfly_pdf/processors/page_thumb_test.rb
+- test/dragonfly_pdf/processors/rotate_test.rb
+- test/dragonfly_pdf/processors/stamp_test.rb
 - test/dragonfly_pdf/processors/subset_fonts.rb
 - test/test_helper.rb
 homepage: https://github.com/tomasc/dragonfly_pdf
@@ -160,14 +167,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Dragonfly PDF analysers and processors.
 test_files:
 - test/dragonfly_pdf/analysers/pdf_properties_test.rb
 - test/dragonfly_pdf/plugin_test.rb
+- test/dragonfly_pdf/processors/append_test.rb
 - test/dragonfly_pdf/processors/page_test.rb
 - test/dragonfly_pdf/processors/page_thumb_test.rb
+- test/dragonfly_pdf/processors/rotate_test.rb
+- test/dragonfly_pdf/processors/stamp_test.rb
 - test/dragonfly_pdf/processors/subset_fonts.rb
 - test/test_helper.rb