pdf_cover 0.1.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install:
+  - gem install bundler -v 1.11.2
+  - sudo apt-get -qq update
+  - sudo apt-get install -y ghostscript
+before_script:
+  - cd spec/dummy && bundle exec rake db:test:prepare && cd -
+  - cd spec && bash generate_jpegs.sh && cd -

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Juan González
+
+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,65 @@
+# PdfCover
+
+![Build Status](https://api.travis-ci.org/xing/pdf_cover.svg)
+[![Coverage Status](https://coveralls.io/repos/github/xing/pdf_cover/badge.svg?branch=master)](https://coveralls.io/github/xing/pdf_cover?branch=master)
+
+With this gem you can easily have attachments for PDF files that have associated
+images generated for their first page.
+
+Support is provided both for [Paperclip](https://github.com/thoughtbot/paperclip)
+and [CarrierWave](https://github.com/carrierwaveuploader/carrierwave).
+
+## Paperclip Support
+
+To add a PDF cover style to your attachments you can do something like this:
+
+```Ruby
+class WithPaperclip < ActiveRecord::Base
+  include PdfCover
+
+  pdf_cover_attachment :pdf, styles: { pdf_cover: ['', :jpeg]},
+    convert_options: { all: '-quality 95' },
+
+  validates_attachment_content_type :pdf, content_type: %w(application/pdf)
+end
+```
+
+This will define an attachment called `pdf` which has a `pdf_cover` style attached
+to it that is a JPEG of the first page in the PDF. You can pass any option that you
+would normally pass to `has_attached_file` in the options hash and it will be
+passed through to the underlying `has_attached_file` call.
+
+## CarrierWave
+
+When using CarrierWave you can implement this gem's functionality
+you can do something like this:
+
+```Ruby
+class WithCarrierwaveUploader < CarrierWave::Uploader::Base
+  include PdfCover
+
+  storage :file
+
+  version :image do
+    pdf_cover_attachment
+  end
+end
+```
+
+In this case, when we mix the `PdfCover` module in, it adds the `pdf_cover_attachment`
+method to our uploader. We only need to call it inside one of our versions to get the
+pdf to image feature.
+
+# Developing this gem
+
+After cloning this gem locally just run the `bin/setup` script to set everything
+up. This will:
+
+- Run `bundle` to install the development dependencies
+- Initialize the database used by the `spec/dummy` rails application that
+we use to test the ActiveRecord+(Paperclip|CarrierWave) integration.
+
+## Running the specs
+
+Once you have setup the gem locally you can just run `rake` from the root folder
+of the gem to run the specs.

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+ENV["RAILS_ENV"] ||= "test"
+
+RSpec::Core::RakeTask.new(:spec).tap do |rspec_task|
+  rspec_task.rspec_opts = "--fail-fast"
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task :run_all_checks do
+  Rake::Task["spec"].invoke
+  Rake::Task["rubocop"].invoke
+end
+
+task default: :run_all_checks

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdf_cover"
+
+# 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,12 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+cd spec/dummy
+bundle exec rake db:test:prepare
+cd -
+
+sh spec/generate_jpegs.sh

data/lib/paperclip/pdf_cover.rb

@@ -0,0 +1,31 @@
+if Kernel.const_defined?(:Paperclip)
+  require "pdf_cover/converter"
+
+  module Paperclip
+    # This is a Paperclip::Processor that can be used to generate an image
+    # from a PDF file. The image is only of the first page.
+    #
+    # We inherit the following instance variables from Paperclip::Processor:
+    #   @file the file that will be operated on (which is an instance of File)
+    #   @options a hash of options that were defined in has_attached_file's style hash
+    #   @attachment the Paperclip::Attachment itself
+    class PdfCover < Processor
+      QUALITY_CONVERT_OPTION_REGEX = /-quality\s+(?<quality>\d+)/
+
+      def make
+        ::PdfCover::Converter.new(@file, format: format, quality: jpeg_quality).converted_file
+      end
+
+      def format
+        @options[:format].to_s
+      end
+
+      def jpeg_quality
+        return nil unless %w(jpeg jpg).include?(format)
+
+        match_data = QUALITY_CONVERT_OPTION_REGEX.match(@options[:convert_options])
+        match_data && match_data[:quality]
+      end
+    end
+  end
+end

data/lib/pdf_cover/converter.rb

@@ -0,0 +1,86 @@
+module PdfCover
+  class Converter
+    class CommandNotFoundError < StandardError
+      def initialize
+        super("Could not run the `gs` command. Make sure that GhostScript is in your PATH.")
+      end
+    end
+
+    def initialize(file, options = {})
+      @file = file
+      @format = options[:format] || "jpeg"
+      @quality = options[:quality] || 95
+    end
+
+    # @raises PdfCover::Converter::CommandNotFoundError if GhostScript is not found
+    def converted_file
+      case convert_file
+        when :ok
+          destination_file
+        when :command_failed
+          @file # TODO: Why this? Shouldn't we just crash?
+        when :command_not_found
+          fail CommandNotFoundError
+      end
+    end
+
+    private
+
+    def basename
+      @basename ||= File.basename(@file.path, File.extname(@file.path))
+    end
+
+    def build_parameters(source, device, destination)
+      %W(-sOutputFile='#{destination}' -dNOPAUSE
+         -sDEVICE='#{device}' -dJPEGQ=#{@quality}
+         -dFirstPage=1 -dLastPage=1
+         -r300 -q '#{source}'
+         -c quit
+      ).join(" ")
+    end
+
+    def convert_file
+      parameters = build_parameters(file_path, device, File.expand_path(destination_file.path))
+      result = execute_command("gs #{parameters}")
+
+      if result
+        :ok
+      else
+        failed_result(result)
+      end
+    end
+
+    def destination_file
+      @destination_file ||= Tempfile.new([basename, ".#{@format}"]).tap do |file|
+        file.binmode
+      end
+    end
+
+    def device
+      @format.to_s == "jpg" ? "jpeg" : @format.to_s
+    end
+
+    def execute_command(command)
+      Kernel.system(command)
+    end
+
+    def failed_result(result)
+      destination_file.close
+
+      if result == false
+        logger.warn("GhostScript execution failed: #{$CHILD_STATUS}")
+        :command_failed
+      else
+        :command_not_found
+      end
+    end
+
+    def file_path
+      @file_path ||= File.expand_path(@file.path)
+    end
+
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDERR)
+    end
+  end
+end

data/lib/pdf_cover/version.rb

@@ -0,0 +1,3 @@
+module PdfCover
+  VERSION = "0.1.0".freeze
+end

data/lib/pdf_cover.rb

@@ -0,0 +1,97 @@
+require "pdf_cover/version"
+require "pdf_cover/converter"
+
+# This module provides methods for CarrierWave::Uploader::Base subclasses and
+# for ActiveRecord models that want to include attachments to simplify the
+# generation of JPEG images from the first page of a PDF file that is uploaded
+# by the users.
+# Include this module in your class and check the `ClassMethods` documentation
+# that corresponds to your attachments managing library in this same file.
+module PdfCover
+  module ClassMethods
+    module CarrierWave
+      # When called in the context of a CarrierWave::Uploader::Base subclass,
+      # this method will add a processor to the currenct attachment or version
+      # that generates a JPEG with 95 quality from the first page of the given
+      # PDF.
+      #
+      # This will not make any validation on the given content type, you must
+      # [do it yourself](https://github.com/carrierwaveuploader/carrierwave#securing-uploads)
+      # on your uploader.
+      #
+      # @example Adding a version to your uploader:
+      #   class WithCarrierwaveUploader < CarrierWave::Uploader::Base
+      #     include PdfCover
+      #
+      #     storage :file
+      #
+      #     version :image do
+      #       pdf_cover_attachment
+      #     end
+      #   end
+      def pdf_cover_attachment
+        process :pdf_cover
+
+        define_method :full_filename do |for_file = model.logo.file|
+          for_file.gsub(/pdf$/, "jpeg")
+        end
+      end
+    end
+
+    module Paperclip
+      # Adds a new attached file to the caller that has the pdf cover processors
+      # prepended to the list of processors given.
+      #
+      # @param attachment_name [Symbol] the name of the new attachment. The fields
+      # described in the Paperclip documentation for attachments are needed for this one.
+      # @param options [Hash] the same options that are accepted by Paperclip, they
+      # are passed to the has_attached_file call with just a new processor
+      # prepended to the given ones. The PdfCover processor will use the quality
+      # provided in the `convert_options` option when generating the jpeg.
+      #
+      # @example A sample ActiveRecord model with a pdf_cover attachment:
+      #   class WithPaperclip < ActiveRecord::Base
+      #     include PdfCover
+      #
+      #     pdf_cover_attachment :pdf, styles: { pdf_cover: ['', :jpeg]},
+      #       convert_options: { all: '-quality 95' }
+      #
+      #     # Note that you must set content type validation as required by Paperclip
+      #     validates_attachment_content_type :pdf, content_type: %w(application/pdf)
+      #   end
+      def pdf_cover_attachment(attachment_name, options = {})
+        options[:processors] = (options[:processors] || []).unshift(:pdf_cover)
+
+        has_attached_file attachment_name, options
+      end
+    end
+  end
+
+  class << self
+    def included(base)
+      if carrierwave_defined?(base)
+        base.extend ClassMethods::CarrierWave
+      elsif paperclip_defined?
+        base.extend ClassMethods::Paperclip
+      else
+        fail "#{base} is not a CarrierWave::Uploader and Paperclip is not defined ¯\\_(ツ)_/¯"
+      end
+    end
+
+    private
+
+    def carrierwave_defined?(base)
+      defined?(CarrierWave::Uploader::Base) && base.ancestors.include?(CarrierWave::Uploader::Base)
+    end
+
+    def paperclip_defined?
+      defined?(Paperclip)
+    end
+  end
+
+  # This is the method used by the PaperClip processor mechanism
+  def pdf_cover
+    converted_file = PdfCover::Converter.new(file).converted_file
+    FileUtils.cp(converted_file, current_path)
+  end
+end

data/pdf_cover.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pdf_cover/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdf_cover"
+  spec.version       = PdfCover::VERSION
+  spec.authors       = ["Juan González"]
+  spec.email         = ["juan.gonzalez@xing.com"]
+
+  spec.summary       = %(Convert first page of a PDF into an image format on Carrierwave and Paperclip )
+  spec.description   = %(Provides processors for both Carrierwave and Paperclip to allow
+                         having a version of a PDF attachment that is actually an image
+                         representing the first page on that PDF. This gem uses GhostScript,
+                         so it must be installed in order for it to work.)
+  spec.homepage      = "http://githum.com/xing/pdf_cover"
+  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 "awesome_print"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.34.1"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "fivemat"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_development_dependency "paperclip", "=4.1.1"
+  spec.add_development_dependency "carrierwave", "~> 0.10"
+
+  spec.add_development_dependency "rmagick", "~> 2.13.2"
+
+  spec.add_runtime_dependency "rails", "~> 4.2.4"
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: pdf_cover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan González
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+description: |-
+  Provides processors for both Carrierwave and Paperclip to allow
+                           having a version of a PDF attachment that is actually an image
+                           representing the first page on that PDF. This gem uses GhostScript,
+                           so it must be installed in order for it to work.
+email:
+- juan.gonzalez@xing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paperclip/pdf_cover.rb
+- lib/pdf_cover.rb
+- lib/pdf_cover/converter.rb
+- lib/pdf_cover/version.rb
+- pdf_cover.gemspec
+homepage: http://githum.com/xing/pdf_cover
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Convert first page of a PDF into an image format on Carrierwave and Paperclip
+test_files: []