dragonfly_pdf 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e969fb6354ce699bbdad681ffacfbfd465ad47a
-  data.tar.gz: 975403373d406f38f528fce2a0c411adf58c9d4b
+  metadata.gz: 2f7513fd9507eb6bf49ad4a51d4204264df9c758
+  data.tar.gz: 235b85f9685ea39fa14dd0e7d25edc876b66142d
 SHA512:
-  metadata.gz: a5a235d8b1bef8fad59fe522472f674c93636cddfff4b6f24dfbe4b40210aec31d2fa4ef674be22eff4c41153f3fa241b43a6f94c65f8ae9c936924ed2f9de5b
-  data.tar.gz: ec751387a15c6110c006c1680be1ecf255698865d1e5e6de8d5146b4e13549aee4714366e9da51041aeaedda0dc199d51ff02d253d0611ae0615f9fd5e1f1306
+  metadata.gz: 6ceffc982e0b65454b263ce97e81aaac26104ac791026184020d2b4b8b9f012cf7dbad491bdc919ea85df685d64450a3193222b95896eea66e7f48214e485936
+  data.tar.gz: a18b986d6de46ba7ae00072da65b884dbf541dfdac594d2cfa453676236fecae4423304dccb208b4db28a987ce2ea4738bbbc72c92f37735a1b58d1224d2dd91

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
     $ gem install dragonfly_pdf
 
-## Plugin
+## Usage
 The analyser and processors are added by configuring the plugin
 
 ```ruby
@@ -32,25 +32,25 @@ Dragonfly.app.configure do
 end
 ```
 
-## Analysers
-
-### PDF properties
+### Spreads
 
-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).
+PDFs that contain spreads (as when saving with the spreads option in InDesign) require setting the `spreads` [metadata](http://markevans.github.io/dragonfly/models/#meta-data) attribute to `true`:
 
 ```ruby
-pdf.pdf_properties(opts={})
+pdf.metadata['spreads'] = true
 ```
 
-The available options and their default values are:
+## Analysers
+
+### PDF properties
+
+Reads properties from a PDF.
 
 ```ruby
-{
-    spreads: false
-}
+pdf.pdf_properties
 ```
 
-Returns Hash of PDF properties:
+It returns a hash of properties:
 
 ```ruby
 {
@@ -64,7 +64,7 @@ Returns Hash of PDF properties:
 }
 ```
 
-When the `spreads` argument is set to true, all page arrays (page_numbers, widths, heights, aspect_ratios) are two dimensional (as illustrated above), representing spreads and nested individual pages.
+When the `spreads` metadata is set to `true`, the analyser assumes the PDF contains 2 real pages per one PDF page and recalculates the PDF properties accordingly (including situations where the PDF begins or ends with a single page). All page arrays (`page_numbers`, `widths`, `heights`, `aspect_ratios`) are then two dimensional (as illustrated above), representing spreads and nested individual pages.
 
 ## Processors
 
@@ -73,15 +73,7 @@ When the `spreads` argument is set to true, all page arrays (page_numbers, width
 Extracts page from PDF.
 
 ```ruby
-pdf.page(page_number=1, opts={})
-```
-
-The available options and their default values are:
-
-```ruby
-{
-    spreads: false
-}
+pdf.page(page_number=1)
 ```
 
 ### Page Thumb
@@ -98,7 +90,6 @@ The available options and their default values are:
 {
     density: 600,
     format: :png,
-    spreads: false
 }
 ```
 
@@ -108,4 +99,4 @@ The available options and their default values are:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request

data/lib/dragonfly_pdf/analysers/pdf_properties.rb

@@ -4,19 +4,19 @@ module DragonflyPdf
   module Analysers
     class PdfProperties
 
-      def call content, opts={}
-        spreads = opts.fetch(:spreads, false)
+      def call content
+        spreads = content.meta['spreads'] || false
 
         pdf = PDF::Reader.new(content.file)
 
         {
+          aspect_ratios: aspect_ratios(pdf, spreads),
+          heights: heights(pdf, spreads),
+          info: pdf.info,
           page_count: page_count(pdf, spreads),
-          spread_count: spread_count(pdf, spreads),
           page_numbers: page_numbers(pdf, spreads),
-          widths: widths(pdf, spreads),
-          heights: heights(pdf, spreads),
-          aspect_ratios: aspect_ratios(pdf, spreads),
-          info: pdf.info
+          spread_count: spread_count(pdf, spreads),
+          widths: widths(pdf, spreads)
         }
       end
 

data/lib/dragonfly_pdf/plugin.rb

@@ -24,11 +24,11 @@ module DragonflyPdf
       app.add_analyser :widths do |content|
         content.analyse(:pdf_properties)[:widths]
       end
-      
+
       app.add_analyser :heights do |content|
         content.analyse(:pdf_properties)[:heights]
       end
-      
+
       app.add_analyser :aspect_ratios do |content|
         attrs = content.analyse(:pdf_properties)[:aspect_ratios]
       end
@@ -36,9 +36,9 @@ module DragonflyPdf
       app.add_analyser :info do |content|
         attrs = content.analyse(:pdf_properties)[:info]
       end
-      
+
       # ---------------------------------------------------------------------
-      
+
       app.add_processor :page_thumb, DragonflyPdf::Processors::PageThumb.new
       app.add_processor :page, DragonflyPdf::Processors::Page.new
     end

data/lib/dragonfly_pdf/processors/page.rb

@@ -7,11 +7,11 @@ module DragonflyPdf
     class Page
 
       def call content, page_number=1, opts={}
-        spreads = opts.fetch(:spreads, false)
+        spreads = content.meta['spreads'] || false
         pdf_page_number = page_number
         crop_args = ''
 
-        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content, spreads: spreads)
+        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content)
 
         raise DragonflyPdf::PageNotFound unless pdf_properties[:page_numbers].flatten.include?(page_number)
 

data/lib/dragonfly_pdf/processors/page_thumb.rb

@@ -7,12 +7,12 @@ module DragonflyPdf
       def call content, page_number=1, opts={}
         format = opts.fetch(:format, :png)
         density = opts.fetch(:density, 600)
-        spreads = opts.fetch(:spreads, false)
+        spreads = content.meta['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: spreads)
+        pdf_properties = DragonflyPdf::Analysers::PdfProperties.new.call(content)
 
         raise DragonflyPdf::PageNotFound unless pdf_properties[:page_numbers].flatten.include?(page_number)
 
@@ -35,7 +35,7 @@ module DragonflyPdf
         content.meta['format'] = format.to_s
         content.ext = format
       end
-   
+
       def update_url attrs, args='', opts={}
         format = opts['format']
         attrs.ext = format if format

data/lib/dragonfly_pdf/version.rb

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

data/test/dragonfly_pdf/analysers/pdf_properties_test.rb

@@ -13,6 +13,13 @@ module DragonflyPdf
       let(:spreads_cover) { app.fetch_file(SAMPLES_DIR.join('sample_spreads_cover.pdf')) }
       let(:spreads_cover_back) { app.fetch_file(SAMPLES_DIR.join('sample_spreads_cover_back.pdf')) }
 
+      before do
+        spreads.meta['spreads'] = true
+        spreads_cover.meta['spreads'] = true
+        spreads_back.meta['spreads'] = true
+        spreads_cover_back.meta['spreads'] = true
+      end
+
       describe 'call' do
         let(:pdf_properties) { analyser.call(single_pages) }
 
@@ -32,25 +39,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns two-dimensional array' do
-            analyser.call(spreads, spreads: true)[:page_numbers].must_equal [[1,2],[3,4],[5,6],[7,8]]
+            analyser.call(spreads)[: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, spreads: true)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9]]
+            analyser.call(spreads_cover)[: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, spreads: true)[:page_numbers].must_equal [[1,2],[3,4],[5,6],[7,8],[9]]
+            analyser.call(spreads_back)[: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, spreads: true)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9],[10]]
+            analyser.call(spreads_cover_back)[:page_numbers].must_equal [[1],[2,3],[4,5],[6,7],[8,9],[10]]
           end
         end
       end
@@ -66,25 +73,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns correct page count' do
-            analyser.call(spreads, spreads: true)[:page_count].must_equal 8
+            analyser.call(spreads)[: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, spreads: true)[:page_count].must_equal 9
+            analyser.call(spreads_cover)[: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, spreads: true)[:page_count].must_equal 9
+            analyser.call(spreads_back)[: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, spreads: true)[:page_count].must_equal 10
+            analyser.call(spreads_cover_back)[:page_count].must_equal 10
           end
         end
       end
@@ -100,25 +107,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns correct page count' do
-            analyser.call(spreads, spreads: true)[:spread_count].must_equal 4
+            analyser.call(spreads)[: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, spreads: true)[:spread_count].must_equal 5
+            analyser.call(spreads_cover)[: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, spreads: true)[:spread_count].must_equal 5
+            analyser.call(spreads_back)[: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, spreads: true)[:spread_count].must_equal 6
+            analyser.call(spreads_cover_back)[:spread_count].must_equal 6
           end
         end
       end
@@ -134,25 +141,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns widths' do
-            analyser.call(spreads, spreads: true)[:widths].must_equal [[210.0, 210.0], [210.0, 210.0], [210.0, 210.0], [210.0, 210.0]]
+            analyser.call(spreads)[: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, spreads: 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)[: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, spreads: 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)[: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, 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]]
+            analyser.call(spreads_cover_back)[: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 +175,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns heights' do
-            analyser.call(spreads, spreads: true)[:heights].must_equal [[297.0, 297.0], [297.0, 297.0], [297.0, 297.0], [297.0, 297.0]]
+            analyser.call(spreads)[: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, spreads: 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)[: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, spreads: 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)[: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, 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]]
+            analyser.call(spreads_cover_back)[: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 +209,25 @@ module DragonflyPdf
 
         describe 'for PDF with spreads' do
           it 'returns aspect ratios' do
-            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]]
+            analyser.call(spreads)[: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, 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]]
+            analyser.call(spreads_cover)[: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, 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]]
+            analyser.call(spreads_back)[: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, 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]]
+            analyser.call(spreads_cover_back)[: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

@@ -9,6 +9,12 @@ module DragonflyPdf
     # ---------------------------------------------------------------------
 
     describe 'analysers' do
+      it 'adds #pdf_properties' do
+        pdf.must_respond_to :pdf_properties
+      end
+      it 'allows an options parameter on #pdf_properties' do
+        pdf.pdf_properties.must_be_kind_of Hash
+      end
       it 'adds #page_count' do
         pdf.must_respond_to :page_count
       end
@@ -32,9 +38,8 @@ module DragonflyPdf
       end
     end
 
-
     # ---------------------------------------------------------------------
-    
+
     describe 'processors' do
       it 'adds #page' do
         pdf.must_respond_to :page

data/test/dragonfly_pdf/processors/page_test.rb

@@ -14,6 +14,13 @@ module DragonflyPdf
       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')) }
 
+      before do
+        spreads.meta['spreads'] = true
+        spreads_cover.meta['spreads'] = true
+        spreads_back.meta['spreads'] = true
+        spreads_cover_back.meta['spreads'] = true
+      end
+
       # =====================================================================
 
       it 'returns PDF by default' do

data/test/dragonfly_pdf/processors/page_thumb_test.rb

@@ -14,6 +14,15 @@ module DragonflyPdf
       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')) }
 
+      before do
+        spreads.meta['spreads'] = true
+        spreads_cover.meta['spreads'] = true
+        spreads_back.meta['spreads'] = true
+        spreads_cover_back.meta['spreads'] = true
+      end
+
+      # =====================================================================
+
       it 'returns PNG by default' do
         processor.call(single_pages, 1, density: 72)
         get_mime_type(single_pages.path).must_include "image/png"
@@ -62,7 +71,7 @@ module DragonflyPdf
       end
 
       # ---------------------------------------------------------------------
-      
+
       def get_mime_type file_path
         `file --mime-type #{file_path}`.gsub(/\n/, "")
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly