pdf_thumbnailer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ead9886da00530609620429ca66638ab420a96a5
-  data.tar.gz: cc91f7aa92555b4e9297ac343213ffd6f2218105
+  metadata.gz: 47f518a6745d7a05c55d8ff96461bfb2ad35eee0
+  data.tar.gz: feb3e239262d77df2cbcdddcf9546255bbca77ab
 SHA512:
-  metadata.gz: 09b9c9aed5769681c3c597040184be341c892a0cf5d1979af07558fa1e546ce4727503cf557b2755e6db8088cb2189042a7c6ba38e826261b0e307529fbb6282
-  data.tar.gz: ce8c4db7ece241943a5278a2811dd7b6c4b73ffa8fd5e1b533bbf64e4a1ddafae855c54b4344e751d9c77d4461fcb76e4f1deadb78b63304bd52cf2e4fb06a08
+  metadata.gz: b35b036a58ff5d89d6b76f281193c1007f7664873e9854219ab2e026e3b028196296f9d791754d85892a21ca1fd8cd681712545bce21dda9cdaadf0a04aee533
+  data.tar.gz: d42b8bcbd3a15a3dc7a0b6391e6c23d60cc60e4755d30ced62de72ff534a60e488346c9060b438d00620c6884268772fca72736ece7f726c8932c51301343121

data/README.md

@@ -27,7 +27,7 @@ First, configure `PdfThumbs`:
 
 ```ruby
 PdfThumbs.configure(
-  pdf_dir: '/some/path/with/pdf/files',  # required
+  pdf_dir: '/some/path/with/pdf/files',
   img_dir: '/where/to/save/page/images', # required
   thumb_sizes: [1000, 500, 100] # max pixel lengths for the long side (height or width) of the page images
 )
@@ -43,6 +43,16 @@ end
 
 `thumbnail!` optionally accepts a code block with one argument.  This argument (`thumb_dir` in the above example) will be a string representing the path of the newly created directory containing page images for a particular pdf.  The folder structure `img_dir` will be identical to that of `pdf_dir` but for every `.pdf` file there will instead be a directory of the same name containing `.png` iamges.
 
+Alternatively a single pdf file can have its pages converted to images using the `thumbnail_single!` method:
+
+```ruby
+PdfThumbs.configure img_dir: '/where/to/save/page/images', thumb_sizes: 500
+
+thumb_dir = PdfThumbs.thumbnail_single! '/pdf/root/dir', 'relative/path/to/My File.pdf'
+
+puts "Page thumbnails are located in: #{thumb_dir}"
+```
+
 
 License
 -----------------------------

data/lib/pdf_thumbnailer/pdf_thumbs.rb

@@ -1,34 +1,31 @@
 class PdfThumbs
   def self.configure **opts
-    [:pdf_dir, :img_dir, :thumb_sizes].each do |required_opt|
+    # [:pdf_dir, :img_dir, :thumb_sizes].each do |required_opt|
+    [:img_dir, :thumb_sizes].each do |required_opt|
       raise ArgumentError, "Missing required config option: :#{required_opt}" unless opts[required_opt]
     end
-    @@pdf_dir = File.join(opts[:pdf_dir], '') # adds trailing '/' if it doesn't already have one
     @@img_dir = File.join(opts[:img_dir], '') # adds trailing '/' if it doesn't already have one
+    @@pdf_dir = File.join(opts[:pdf_dir], '') if opts[:pdf_dir]# adds trailing '/' if it doesn't already have one
     @@thumb_sizes = opts[:thumb_sizes].is_a?(Fixnum) ? [opts[:thumb_sizes]] : opts[:thumb_sizes]
   end
 
   def self.thumbnail!
     Dir.glob(File.join(@@pdf_dir, '**', '*.pdf')) do |pdf|
-      img_dir = clear_img_dir pdf
-
-      @@thumb_sizes.each do |thumb_size|
-        `pdftoppm -png -scale-to #{thumb_size} "#{pdf}" "#{img_dir}"`
-
-        Dir.glob(File.join(img_dir, '-*.png')) do |img_path|
-          page_num = File.basename(img_path, '.png').split('-')[-1].to_i
-          File.rename(img_path, File.join(img_dir, "#{thumb_size}_#{page_num}.png"))
-        end
-      end
+      img_dir = thumbnail_pdf @@pdf_dir, pdf.gsub(@@pdf_dir, '')
       yield(img_dir) if block_given?
     end
   end
 
+  # TODO: add spec and document in README.md
+  def self.thumbnail_single! pdf_dir, relative_pdf_path
+    thumbnail_pdf pdf_dir, relative_pdf_path
+  end
+
   private
 
-  def self.clear_img_dir pdf
-    relative_path = File.dirname pdf.gsub(@@pdf_dir, '')
-    relative_img_path = relative_path == '.' ? File.basename(pdf) : File.join(relative_path, File.basename(pdf))
+  def self.clear_img_dir relative_pdf_path
+    relative_path = File.dirname relative_pdf_path
+    relative_img_path = relative_path == '.' ? File.basename(relative_pdf_path) : File.join(relative_path, File.basename(relative_pdf_path))
     img_dir = File.join(@@img_dir, relative_img_path, '')
 
     FileUtils.rm_rf(img_dir) if File.directory?(img_dir)
@@ -36,4 +33,19 @@ class PdfThumbs
 
     img_dir
   end
+
+  def self.thumbnail_pdf pdf_dir, relative_pdf_path
+    img_dir = clear_img_dir relative_pdf_path
+
+    @@thumb_sizes.each do |thumb_size|
+      `pdftoppm -png -scale-to #{thumb_size} "#{File.join(pdf_dir, relative_pdf_path)}" "#{img_dir}"`
+
+      Dir.glob(File.join(img_dir, '-*.png')) do |img_path|
+        page_num = File.basename(img_path, '.png').split('-')[-1].to_i
+        File.rename(img_path, File.join(img_dir, "#{thumb_size}_#{page_num}.png"))
+      end
+    end
+
+    img_dir
+  end
 end

data/lib/pdf_thumbnailer/version.rb

@@ -1,3 +1,3 @@
 module PdfThumbnailer
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_thumbnailer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler