dragonfly_pdf 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39808b6176e5805a9bc82d359f9d427bc42e476c
-  data.tar.gz: 60b458c14a7531d7a457f274b58ad4ce67a48ab8
+  metadata.gz: 5e969fb6354ce699bbdad681ffacfbfd465ad47a
+  data.tar.gz: 975403373d406f38f528fce2a0c411adf58c9d4b
 SHA512:
-  metadata.gz: beee74901265a5e8f0c674f82d328140b5794385adb0f7d93514afc328df34a64e62210a86913ed3966c4fa0752e5e882c6b98c235e4b37ea371489516abac25
-  data.tar.gz: 88c5d02b9e3eea8c8a59d128b8e3b0381197abbb28b9102712bcfb91cdde6094373f77291160e11706546de3a8cfe256fa5e1474e94a048734dfa4f4d8611db5
+  metadata.gz: a5a235d8b1bef8fad59fe522472f674c93636cddfff4b6f24dfbe4b40210aec31d2fa4ef674be22eff4c41153f3fa241b43a6f94c65f8ae9c936924ed2f9de5b
+  data.tar.gz: ec751387a15c6110c006c1680be1ecf255698865d1e5e6de8d5146b4e13549aee4714366e9da51041aeaedda0dc199d51ff02d253d0611ae0615f9fd5e1f1306

data/README.md

@@ -4,6 +4,11 @@
 
 [Dragonfly](https://github.com/markevans/dragonfly) PDF analysers and processors.
 
+## Dependencies
+
+* [ImageMagick](http://www.imagemagick.org)
+* [GhostScript](http://www.ghostscript.com)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,7 +39,15 @@ end
 This processor has argument `spreads` (by default set to `false`). When `true`, the analyser assumes the PDF might contain 2 real pages per one PDF page (as when saving with the spreads option in InDesign) and recalculates the PDF properties accordingly (including situations when PDF starts or ends with single page).
 
 ```ruby
-pdf.pdf_properties(spreads=false)
+pdf.pdf_properties(opts={})
+```
+
+The available options and their default values are:
+
+```ruby
+{
+    spreads: false
+}
 ```
 
 Returns Hash of PDF properties:
@@ -55,12 +68,28 @@ When the `spreads` argument is set to true, all page arrays (page_numbers, width
 
 ## Processors
 
+### Page
+
+Extracts page from PDF.
+
+```ruby
+pdf.page(page_number=1, opts={})
+```
+
+The available options and their default values are:
+
+```ruby
+{
+    spreads: false
+}
+```
+
 ### Page Thumb
 
 Generates thumbnail of a specified page, in defined density (dpi) and format.
 
 ```ruby
-pdf.page_thumb(page_number=0, opts={})
+pdf.page_thumb(page_number=1, opts={})
 ```
 
 The available options and their default values are:
@@ -73,12 +102,6 @@ The available options and their default values are:
 }
 ```
 
-Similarly to the `#pdf_properties`, the `#page_thumb` processor takes into account the `spreads` option.
-
-## TODO
-
-* Add more tests for `#page_thumb`
-
 ## Contributing
 
 1. Fork it ( https://github.com/tomasc/dragonfly_pdf/fork )

data/lib/dragonfly_pdf/analysers/pdf_properties.rb

@@ -4,7 +4,9 @@ module DragonflyPdf
   module Analysers
     class PdfProperties
 
-      def call content, spreads=false
+      def call content, opts={}
+        spreads = opts.fetch(:spreads, false)
+
         pdf = PDF::Reader.new(content.file)
 
         {

data/lib/dragonfly_pdf/errors.rb

@@ -0,0 +1,3 @@
+module DragonflyPdf
+  class PageNotFound < RuntimeError; end
+end

data/lib/dragonfly_pdf/plugin.rb

@@ -1,4 +1,6 @@
 require 'dragonfly_pdf/analysers/pdf_properties'
+
+require 'dragonfly_pdf/processors/page'
 require 'dragonfly_pdf/processors/page_thumb'
 
 module DragonflyPdf
@@ -38,6 +40,7 @@ module DragonflyPdf
       # ---------------------------------------------------------------------
       
       app.add_processor :page_thumb, DragonflyPdf::Processors::PageThumb.new
+      app.add_processor :page, DragonflyPdf::Processors::Page.new
     end
 
   end

data/lib/dragonfly_pdf/processors/page.rb

@@ -0,0 +1,50 @@
+require 'pdf-reader'
+require_relative '../errors'
+require_relative '../analysers/pdf_properties'
+
+module DragonflyPdf
+  module Processors
+    class Page
+
+      def call content, page_number=1, opts={}
+        spreads = opts.fetch(:spreads, false)
+        pdf_page_number = page_number
+        crop_args = ''
+
+        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content, spreads: spreads)
+
+        raise DragonflyPdf::PageNotFound unless pdf_properties[:page_numbers].flatten.include?(page_number)
+
+        if spreads
+          spread = pdf_properties[:page_numbers].detect{ |s| s.include?(page_number) }
+          spread_number = pdf_properties[:page_numbers].index(spread)
+          spread_side = spread.index(page_number)
+
+          pdf_page_number = spread_number+1
+
+          pdf = PDF::Reader.new(content.path)
+          box = pdf.pages[spread_number].attributes[:MediaBox] || pdf.pages[spread_number].attributes[:CropBox]
+
+          crop_box = box
+          crop_box[2] = crop_box[2]/2
+          crop_box[0] += crop_box[2] * spread_side
+          crop_box[2] += crop_box[2] * spread_side
+
+          crop_args = "-c '[/CropBox [#{crop_box.join(' ')}] /PAGES pdfmark'"
+        end
+
+        content.shell_update(ext: :pdf) do |old_path, new_path|
+          "#{gs_command} -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -dFirstPage=#{pdf_page_number} -dLastPage=#{pdf_page_number} -o #{new_path} #{crop_args} -f #{old_path}"
+        end
+      end
+
+
+      private # =============================================================
+      
+      def gs_command
+        'gs'
+      end
+
+    end
+  end
+end

data/lib/dragonfly_pdf/processors/page_thumb.rb

@@ -4,19 +4,17 @@ module DragonflyPdf
   module Processors
     class PageThumb
 
-      class UnsupportedFormat < RuntimeError; end
-
-      def call content, page_number=0, opts={}
+      def call content, page_number=1, opts={}
         format = opts.fetch(:format, :png)
-        # raise UnsupportedFormat unless %w(tif jpg jpeg png gif).include?(format.to_s)
-
         density = opts.fetch(:density, 600)
         spreads = opts.fetch(:spreads, false)
 
         args = "-alpha deactivate -background white -colorspace sRGB -density #{density}x#{density} -define pdf:use-cropbox=true -define pdf:use-trimbox=true"
         crop_args = ''
 
-        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content, spreads)
+        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content, spreads: spreads)
+
+        raise DragonflyPdf::PageNotFound unless pdf_properties[:page_numbers].flatten.include?(page_number)
 
         if spreads
           spread = pdf_properties[:page_numbers].detect{ |s| s.include?(page_number) }
@@ -27,7 +25,7 @@ module DragonflyPdf
           pdf_page_number = spread_number
           crop_args = "-crop 50%x100% -delete #{page_to_delete}"
         else
-          pdf_page_number = page_number
+          pdf_page_number = page_number-1
         end
 
         content.shell_update(ext: format) do |old_path, new_path|

data/lib/dragonfly_pdf/version.rb

@@ -1,3 +1,3 @@
 module DragonflyPdf
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/dragonfly_pdf/analysers/pdf_properties_test.rb

@@ -32,25 +32,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns two-dimensional array' do
-            analyser.call(spreads, true)[:page_numbers].must_equal [[1,2],[3,4],[5,6],[7,8]]
+            analyser.call(spreads, spreads: true)[:page_numbers].must_equal [[1,2],[3,4],[5,6],[7,8]]
           end
         end
 
         describe 'for PDF with spreads and a cover' do
           it 'returns two-dimensional array' do
-            analyser.call(spreads_cover, true)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9]]
+            analyser.call(spreads_cover, spreads: true)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9]]
           end
         end
 
         describe 'for PDF with spreads and a back cover' do
           it 'returns two-dimensional array' do
-            analyser.call(spreads_back, true)[:page_numbers].must_equal [[1,2],[3,4],[5,6],[7,8],[9]]
+            analyser.call(spreads_back, spreads: true)[:page_numbers].must_equal [[1,2],[3,4],[5,6],[7,8],[9]]
           end
         end
 
         describe 'for PDF with spreads and a front and a back cover' do
           it 'returns two-dimensional array' do
-            analyser.call(spreads_cover_back, true)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9],[10]]
+            analyser.call(spreads_cover_back, spreads: true)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9],[10]]
           end
         end
       end
@@ -66,25 +66,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns correct page count' do
-            analyser.call(spreads, true)[:page_count].must_equal 8
+            analyser.call(spreads, spreads: true)[:page_count].must_equal 8
           end
         end
 
         describe 'for PDF with spreads and a cover' do
           it 'returns correct page count' do
-            analyser.call(spreads_cover, true)[:page_count].must_equal 9
+            analyser.call(spreads_cover, spreads: true)[:page_count].must_equal 9
           end
         end
 
         describe 'for PDF with spreads and a back cover' do
           it 'returns correct page count' do
-            analyser.call(spreads_back, true)[:page_count].must_equal 9
+            analyser.call(spreads_back, spreads: true)[:page_count].must_equal 9
           end
         end
 
         describe 'for PDF with spreads and a front and a back cover' do
           it 'returns correct page count' do
-            analyser.call(spreads_cover_back, true)[:page_count].must_equal 10
+            analyser.call(spreads_cover_back, spreads: true)[:page_count].must_equal 10
           end
         end
       end
@@ -100,25 +100,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns correct page count' do
-            analyser.call(spreads, true)[:spread_count].must_equal 4
+            analyser.call(spreads, spreads: true)[:spread_count].must_equal 4
           end
         end
 
         describe 'for PDF with spreads and a cover' do
           it 'returns correct page count' do
-            analyser.call(spreads_cover, true)[:spread_count].must_equal 5
+            analyser.call(spreads_cover, spreads: true)[:spread_count].must_equal 5
           end
         end
 
         describe 'for PDF with spreads and a back cover' do
           it 'returns correct page count' do
-            analyser.call(spreads_back, true)[:spread_count].must_equal 5
+            analyser.call(spreads_back, spreads: true)[:spread_count].must_equal 5
           end
         end
 
         describe 'for PDF with spreads and a front and a back cover' do
           it 'returns correct page count' do
-            analyser.call(spreads_cover_back, true)[:spread_count].must_equal 6
+            analyser.call(spreads_cover_back, spreads: true)[:spread_count].must_equal 6
           end
         end
       end
@@ -134,25 +134,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns widths' do
-            analyser.call(spreads, true)[:widths].must_equal [[210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0]]
+            analyser.call(spreads, spreads: true)[:widths].must_equal [[210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0]]
           end
         end
 
         describe 'for PDF with spreads and a cover' do
           it 'returns correct widths' do
-            analyser.call(spreads_cover, true)[:widths].must_equal [[210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0]]
+            analyser.call(spreads_cover, spreads: true)[:widths].must_equal [[210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0]]
           end
         end
 
         describe 'for PDF with spreads and a back cover' do
           it 'returns correct widths' do
-            analyser.call(spreads_back, true)[:widths].must_equal [[210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0]]
+            analyser.call(spreads_back, spreads: true)[:widths].must_equal [[210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0]]
           end
         end
 
         describe 'for PDF with spreads and a front and a back cover' do
           it 'returns correct widths' do
-            analyser.call(spreads_cover_back, true)[:widths].must_equal [[210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0]]
+            analyser.call(spreads_cover_back, spreads: true)[:widths].must_equal [[210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0]]
           end
         end
       end
@@ -168,25 +168,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns heights' do
-            analyser.call(spreads, true)[:heights].must_equal [[297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0]]
+            analyser.call(spreads, spreads: true)[:heights].must_equal [[297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0]]
           end
         end
 
         describe 'for PDF with spreads and a cover' do
           it 'returns correct heights' do
-            analyser.call(spreads_cover, true)[:heights].must_equal [[297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0]]
+            analyser.call(spreads_cover, spreads: true)[:heights].must_equal [[297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0]]
           end
         end
 
         describe 'for PDF with spreads and a back cover' do
           it 'returns correct heights' do
-            analyser.call(spreads_back, true)[:heights].must_equal [[297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0]]
+            analyser.call(spreads_back, spreads: true)[:heights].must_equal [[297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0]]
           end
         end
 
         describe 'for PDF with spreads and a front and a back cover' do
           it 'returns correct heights' do
-            analyser.call(spreads_cover_back, true)[:heights].must_equal [[297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0]]
+            analyser.call(spreads_cover_back, spreads: true)[:heights].must_equal [[297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0]]
           end
         end
       end
@@ -202,25 +202,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns aspect ratios' do
-            analyser.call(spreads, true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71]]
+            analyser.call(spreads, spreads: true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71]]
           end
         end
 
         describe 'for PDF with spreads and a cover' do
           it 'returns correct aspect ratios' do
-            analyser.call(spreads_cover, true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71]]
+            analyser.call(spreads_cover, spreads: true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71]]
           end
         end
 
         describe 'for PDF with spreads and a back cover' do
           it 'returns correct aspect ratios' do
-            analyser.call(spreads_back, true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71]]
+            analyser.call(spreads_back, spreads: true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71]]
           end
         end
 
         describe 'for PDF with spreads and a front and a back cover' do
           it 'returns correct aspect ratios' do
-            analyser.call(spreads_cover_back, true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71]]
+            analyser.call(spreads_cover_back, spreads: true)[:aspect_ratios].map{ |i| i.is_a?(Array) ? i.map{ |j| j.round(2) } : i.round(2) }.must_equal [[0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71, 0.71], [0.71]]
           end
         end
       end

data/test/dragonfly_pdf/plugin_test.rb

@@ -32,5 +32,17 @@ module DragonflyPdf
       end
     end
 
+
+    # ---------------------------------------------------------------------
+    
+    describe 'processors' do
+      it 'adds #page' do
+        pdf.must_respond_to :page
+      end
+      it 'adds #page_thumb' do
+        pdf.must_respond_to :page_thumb
+      end
+    end
+
   end
 end

data/test/dragonfly_pdf/processors/page_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+require 'pdf-reader'
+
+module DragonflyPdf
+  module Processors
+    describe Page do
+
+      let(:app) { test_app.configure_with(:pdf) }
+      let(:processor) { DragonflyPdf::Processors::Page.new }
+
+      let(:single_pages) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_pages.pdf')) }
+      let(:spreads) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_spreads.pdf')) }
+      let(:spreads_back) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_spreads_back.pdf')) }
+      let(:spreads_cover) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_spreads_cover.pdf')) }
+      let(:spreads_cover_back) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_spreads_cover_back.pdf')) }
+
+      # =====================================================================
+
+      it 'returns PDF by default' do
+        processor.call(single_pages, 1)
+        get_mime_type(single_pages.path).must_include "application/pdf"
+      end
+
+      it 'raises PageNotFound error' do
+        proc { processor.call(single_pages, 0) }.must_raise DragonflyPdf::PageNotFound
+        proc { processor.call(single_pages, 11) }.must_raise DragonflyPdf::PageNotFound
+      end
+
+      # ---------------------------------------------------------------------
+
+      describe 'single pages' do
+        it 'renders page' do
+          processor.call(single_pages, 1)
+          pdf = PDF::Reader.new(single_pages.path)
+          pdf.pages.count.must_equal 1
+          pdf.pages.first.text.must_equal '1'
+        end
+      end
+
+      describe 'spreads' do
+        it 'recalculates the page number correctly' do
+          processor.call(spreads, 8, spreads: true)
+          pdf = PDF::Reader.new(spreads.path)
+          pdf.pages.count.must_equal 1
+          pdf.pages.first.text.must_include '8'
+        end
+      end
+
+      describe 'spreads_back' do
+        it 'recalculates the page number correctly' do
+          processor.call(spreads_back, 9, spreads: true)
+          pdf = PDF::Reader.new(spreads_back.path)
+          pdf.pages.count.must_equal 1
+          pdf.pages.first.text.must_include '9'
+        end
+      end
+
+      describe 'spreads_cover' do
+        it 'recalculates the page number correctly' do
+          processor.call(spreads_cover, 9, spreads: true)
+          pdf = PDF::Reader.new(spreads_cover.path)
+          pdf.pages.count.must_equal 1
+          pdf.pages.first.text.must_include '9'
+        end
+      end
+
+      describe 'spreads_cover_back' do
+        it 'recalculates the page number correctly' do
+          processor.call(spreads_cover_back, 10, spreads: true)
+          pdf = PDF::Reader.new(spreads_cover_back.path)
+          pdf.pages.count.must_equal 1
+          pdf.pages.first.text.must_include '10'
+        end
+      end
+
+      # ---------------------------------------------------------------------
+
+      def get_mime_type file_path
+        `file --mime-type #{file_path}`.gsub(/\n/, "")
+      end
+
+    end
+  end
+end

data/test/dragonfly_pdf/processors/page_thumb_test.rb

@@ -15,10 +15,15 @@ module DragonflyPdf
       let(:spreads_cover_back) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample_spreads_cover_back.pdf')) }
 
       it 'returns PNG by default' do
-        processor.call(single_pages, 0, density: 72)
+        processor.call(single_pages, 1, density: 72)
         get_mime_type(single_pages.path).must_include "image/png"
       end
 
+      it 'raises PageNotFound error' do
+        proc { processor.call(single_pages, 0) }.must_raise DragonflyPdf::PageNotFound
+        proc { processor.call(single_pages, 11) }.must_raise DragonflyPdf::PageNotFound
+      end
+
       # ---------------------------------------------------------------------
 
       describe 'single pages' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tomas Celizna
@@ -124,7 +124,9 @@ files:
 - dragonfly_pdf.gemspec
 - lib/dragonfly_pdf.rb
 - lib/dragonfly_pdf/analysers/pdf_properties.rb
+- lib/dragonfly_pdf/errors.rb
 - lib/dragonfly_pdf/plugin.rb
+- lib/dragonfly_pdf/processors/page.rb
 - lib/dragonfly_pdf/processors/page_thumb.rb
 - lib/dragonfly_pdf/version.rb
 - samples/sample_pages.pdf
@@ -134,6 +136,7 @@ files:
 - samples/sample_spreads_cover_back.pdf
 - test/dragonfly_pdf/analysers/pdf_properties_test.rb
 - test/dragonfly_pdf/plugin_test.rb
+- test/dragonfly_pdf/processors/page_test.rb
 - test/dragonfly_pdf/processors/page_thumb_test.rb
 - test/test_helper.rb
 homepage: https://github.com/tomasc/dragonfly_pdf
@@ -163,5 +166,6 @@ 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/page_test.rb
 - test/dragonfly_pdf/processors/page_thumb_test.rb
 - test/test_helper.rb