pdf-burst 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# PDF::Burst Changelog
+
+## 0.2.0 (2010-06-30)
+
+Adds thumbnail generation using 'convert' from ImageMagick. Check out the README file for more information.
+
+Renamed options:
+
+* :output_path => :output
+* :output_filename => :filename

data/README.md

@@ -0,0 +1,46 @@
+# PDF::Burst
+
+## What?
+
+PDF::Burst is a gem that lets you split a PDF document with several pages into single page files.
+
+
+## Why?
+
+We needed this functionality for the development of [Lehtilompakko](http://lehtilompakko.fi/), and did not want any Java app to do the job.
+
+
+## How?
+
+Simple! Once you install the 'pdf-burst' gem, all you need is:
+
+    require 'pdf-burst'
+    PDF::Burst.new("/path/to/my/document.pdf").run!
+
+By default, the PDF files will be output to your current working directory. But that's not what you want, is it?
+
+    PDF::Burst.new("document.pdf", :output => "/tmp").run!
+
+Better, huh?
+
+Another default is the page name. They'll all be nicely named like "page_1.pdf", "page_2.pdf". We let you change that too:
+
+    PDF::Burst.new("document.pdf", :filename => "doc.%04d").run!
+
+Would output them like this: "doc.0001.pdf", "doc.0002.pdf", etc.
+
+If you want thumbnails to be generated for each page, just use the thumbnail option with the thumbnail size.
+
+    PDF::Burst.new("document.pdf", :thumbnail => "128x128").run!
+
+This requires ImageMagick to be installed, as it uses the 'convert' command.
+
+
+## Special thanks
+
+Thanks to [Hopeinen Norsu](http://hopeinennorsu.fi/) for letting us release this as open-source.
+
+
+## License
+
+Check the LICENSE file. It's the MIT license.

data/lib/pdf/burst.rb

@@ -2,14 +2,16 @@ module PDF
   class Burst
     def initialize(pdf_path, options={})
       @pdf_path = pdf_path
-      @output_path = options[:output_path] || "."
-      @page_name = options[:output_filename] || "page_%d"
+      @output_path = options[:output] || "."
+      @page_name = options[:filename] || "page_%d"
+      @thumbnail_size = options[:thumbnail]
     end
     
     def run!
       page_count.times do |i|
         page_number = i + 1
         system burst_command(page_number)
+        system thumbnail_command(page_number) if generate_thumbnail?
       end
     end
     
@@ -17,6 +19,10 @@ module PDF
       `#{page_count_command}`.to_i
     end
     
+    def generate_thumbnail?
+      !!@thumbnail_size
+    end
+    
     private
     
     def page_count_command
@@ -27,12 +33,16 @@ module PDF
       "gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -dFirstPage=#{page_number} -dAutoFilterColorImages=false -dAutoFilterGrayImage=false -dColorImageFilter=/FlateEncode -dLastPage=#{page_number} -sOutputFile='#{output_file_path(page_number)}' '#{@pdf_path}'"
     end
     
-    def page_filename(page_number)
-      @page_name % page_number + ".pdf"
+    def thumbnail_command(page_number)
+      "convert -resize #{@thumbnail_size} #{output_file_path(page_number)} #{output_file_path(page_number, 'png')}"
+    end
+    
+    def page_filename(page_number, extension="pdf")
+      @page_name % page_number + ".#{extension}"
     end
     
-    def output_file_path(page_number)
-      File.expand_path("#{@output_path}/#{page_filename(page_number)}")
+    def output_file_path(page_number, extension="pdf")
+      File.expand_path("#{@output_path}/#{page_filename(page_number, extension)}")
     end
   end
 end

data/lib/pdf/burst/version.rb

@@ -1,5 +1,5 @@
 module PDF
   class Burst
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pdf-burst
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Joao Carlos
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-01 00:00:00 +03:00
+date: 2010-06-30 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
-description: "Creates a PDF for each page from a PDF with multiple pages. Uses Ghostscript for the actual bursting. You'll need the following commands available on your system: gs (Ghostscript), pdfinfo (Poppler) and grep."
+description: "Creates a PDF for each page from a PDF with multiple pages. Uses Ghostscript for the actual bursting. You'll need the following commands available on your system: gs (Ghostscript), pdfinfo (Poppler), grep and convert (ImageMagick) if you want thumbnails."
 email: 
 - mail@joao-carlos.com
 executables: 
@@ -29,11 +29,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/pdf/burst/version.rb
-- lib/pdf/burst.rb
 - lib/pdf-burst.rb
+- lib/pdf/burst.rb
+- lib/pdf/burst/version.rb
 - bin/pdf-burst
 - LICENSE
+- CHANGELOG.md
+- README.md
 has_rdoc: true
 homepage: http://github.com/kiskolabs/pdf-burst
 licenses: []