pdf_thumbnailer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ead9886da00530609620429ca66638ab420a96a5
+  data.tar.gz: cc91f7aa92555b4e9297ac343213ffd6f2218105
+SHA512:
+  metadata.gz: 09b9c9aed5769681c3c597040184be341c892a0cf5d1979af07558fa1e546ce4727503cf557b2755e6db8088cb2189042a7c6ba38e826261b0e307529fbb6282
+  data.tar.gz: ce8c4db7ece241943a5278a2811dd7b6c4b73ffa8fd5e1b533bbf64e4a1ddafae855c54b4344e751d9c77d4461fcb76e4f1deadb78b63304bd52cf2e4fb06a08

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pdf_thumbnailer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sean Huber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+pdf_thumbnailer
+==============
+
+`pdf_thumbnailer` converts a folder structure containing `.pdf` files into a folder structure of `.png` files.  Each `.png` represents a single page of the pdf and can be scaled to one or more pixel widths/heights.
+
+
+Requirements and Dependencies
+-----------------------------
+
+Developed/Tested with Ruby version 2.3, but it should work with any version >= 1.9.  Page image creation is done through the `pdftoppm` utility, which can be installed on \*NIX (Linux/OSX) operating systems.
+
+
+Installation
+-----------------------------
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'pdf_thumbnailer', '~> 1.0'
+```
+
+
+Usage
+-----------------------------
+
+First, configure `PdfThumbs`:
+
+```ruby
+PdfThumbs.configure(
+  pdf_dir: '/some/path/with/pdf/files',  # required
+  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
+)
+```
+
+To generate the page images, execute `.thumbnail!`:
+
+```ruby
+PdfThumbs.thumbnail! do |thumb_dir|
+  puts "Page thumbnails are located in: #{thumb_dir}"
+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.
+
+
+License
+-----------------------------
+
+MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdf_thumbnailer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pdf_thumbnailer/pdf_thumbs.rb

@@ -0,0 +1,39 @@
+class PdfThumbs
+  def self.configure **opts
+    [:pdf_dir, :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
+    @@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
+      yield(img_dir) if block_given?
+    end
+  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))
+    img_dir = File.join(@@img_dir, relative_img_path, '')
+
+    FileUtils.rm_rf(img_dir) if File.directory?(img_dir)
+    FileUtils.mkdir_p img_dir
+
+    img_dir
+  end
+end

data/lib/pdf_thumbnailer/version.rb

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

data/lib/pdf_thumbnailer.rb

@@ -0,0 +1,2 @@
+require 'pdf_thumbnailer/version'
+require 'pdf_thumbnailer/pdf_thumbs'

data/pdf_thumbnailer.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdf_thumbnailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pdf_thumbnailer'
+  spec.version       = PdfThumbnailer::VERSION
+  spec.authors       = ['Sean Huber']
+  spec.email         = ['seanhuber@seanhuber.com']
+  spec.summary       = 'Takes a folder structure of PDF files and generates thumbnail images for all pages of all pdfs.'
+  spec.homepage      = 'https://github.com/seanhuber/pdf_thumbnailer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: pdf_thumbnailer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Huber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- seanhuber@seanhuber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pdf_thumbnailer.rb
+- lib/pdf_thumbnailer/pdf_thumbs.rb
+- lib/pdf_thumbnailer/version.rb
+- pdf_thumbnailer.gemspec
+homepage: https://github.com/seanhuber/pdf_thumbnailer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Takes a folder structure of PDF files and generates thumbnail images for
+  all pages of all pdfs.
+test_files: []