pdf_cover 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 121dae8a49997f32af545bffb534d921f77ff0cc
-  data.tar.gz: e583d27e90f8cabe123056530af5fcafdeb835dd
+  metadata.gz: 97202642bc05deda3ecf113ac840a054a9d6af36
+  data.tar.gz: b4e6417e3be0d9efa7706fd9e704d9115cc69b68
 SHA512:
-  metadata.gz: 2d5597d5be8543762580e9cb36c13062256ad5dc950cb31eaf872dceeff77b1a253bd23b6abc62257da67849cf5b709c39b1a7b125597da0a54ab1dc977a90ea
-  data.tar.gz: 74481ca0bbacd20a37ed7e979f5f71d2afa003b4ed7ae03cd6117c0556671ef506cb970967e513c1d668d4a20516fc0765887b53d057544029f16a371998a768
+  metadata.gz: 5181a73f41d036c73277a91df1071494cfd67fd4001e501cf282a77bef379ed48f29c13b413ae06d7d708e00a09f9740cb8fb60e1d41aaac88086a582045e504
+  data.tar.gz: ba2c5f6520f4e7dd278cdfde851021cc572ac0a72d8fc10e1e9875c266803c2830fe0d78706721f1c8305709077e45c8879d894e42880a8755d0d5ea260e8b2d

data/.rubocop.yml

@@ -18,8 +18,8 @@ AllCops:
 
   # By default, the rails cops are not run. Override in project or home
   # directory .rubocop.yml files, or by giving the -R/--rails option.
-Rails:
-  Enabled: true
+  Rails:
+    Enabled: true
 
 # Indent private/protected/public as deep as method definitions
 AccessModifierIndentation:

data/README.md

@@ -1,7 +1,4 @@
-# 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)
+# PdfCover [![Build Status](https://api.travis-ci.org/xing/pdf_cover.svg)](https://travis-ci.org/xing/pdf_cover) [![Code Climate](https://codeclimate.com/github/xing/pdf_cover/badges/gpa.svg)](https://codeclimate.com/github/xing/pdf_cover) [![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.
@@ -9,6 +6,9 @@ images generated for their first page.
 Support is provided both for [Paperclip](https://github.com/thoughtbot/paperclip)
 and [CarrierWave](https://github.com/carrierwaveuploader/carrierwave).
 
+In both cases the JPEG quality and resolution are optional and will be set to 85%
+and 300dpi respectively when not provided.
+
 ## Paperclip Support
 
 To add a PDF cover style to your attachments you can do something like this:
@@ -18,7 +18,7 @@ class WithPaperclip < ActiveRecord::Base
   include PdfCover
 
   pdf_cover_attachment :pdf, styles: { pdf_cover: ['', :jpeg]},
-    convert_options: { all: '-quality 95' },
+    convert_options: { all: '-quality 95 -density 300' },
 
   validates_attachment_content_type :pdf, content_type: %w(application/pdf)
 end
@@ -41,7 +41,7 @@ class WithCarrierwaveUploader < CarrierWave::Uploader::Base
   storage :file
 
   version :image do
-    pdf_cover_attachment
+    pdf_cover_attachment quality: 95, resolution: 300
   end
 end
 ```

data/lib/paperclip/pdf_cover.rb

@@ -11,20 +11,33 @@ if Kernel.const_defined?(:Paperclip)
     #   @attachment the Paperclip::Attachment itself
     class PdfCover < Processor
       QUALITY_CONVERT_OPTION_REGEX = /-quality\s+(?<quality>\d+)/
+      RESOLUTION_CONVERT_OPTION_REGEX = /-density\s+(?<resolution>\d+)/
 
       def make
-        ::PdfCover::Converter.new(@file, format: format, quality: jpeg_quality).converted_file
+        ::PdfCover::Converter.new(@file, converter_options).converted_file
+      end
+
+      def converter_options
+        format.merge(jpeg_quality).merge(jpeg_resolution)
       end
 
       def format
-        @options[:format].to_s
+        { format: @options[:format].to_s }
       end
 
       def jpeg_quality
-        return nil unless %w(jpeg jpg).include?(format)
+        extract_convert_option(:quality, QUALITY_CONVERT_OPTION_REGEX)
+      end
+
+      def jpeg_resolution
+        extract_convert_option(:resolution, RESOLUTION_CONVERT_OPTION_REGEX)
+      end
+
+      def extract_convert_option(key, regex)
+        match_data = regex.match(@options[:convert_options])
+        match = match_data && match_data[key]
 
-        match_data = QUALITY_CONVERT_OPTION_REGEX.match(@options[:convert_options])
-        match_data && match_data[:quality]
+        match ? { key => match } : {}
       end
     end
   end

data/lib/pdf_cover/converter.rb

@@ -1,15 +1,25 @@
 module PdfCover
   class Converter
+    # NOTE: Update the generate_jpegs.sh script when changing these values
+    DEFAULT_FORMAT = "jpeg"
+    DEFAULT_QUALITY = 85
+    DEFAULT_RESOLUTION = 300
+
     class CommandNotFoundError < StandardError
       def initialize
         super("Could not run the `gs` command. Make sure that GhostScript is in your PATH.")
       end
     end
 
+    class InvalidOption < StandardError
+      def initialize(option_name, option_value)
+        super("Invalid option '#{option_name}' with value: '#{option_value}'")
+      end
+    end
+
     def initialize(file, options = {})
       @file = file
-      @format = options[:format] || "jpeg"
-      @quality = options[:quality] || 95
+      extract_options(options)
     end
 
     # @raises PdfCover::Converter::CommandNotFoundError if GhostScript is not found
@@ -18,7 +28,7 @@ module PdfCover
         when :ok
           destination_file
         when :command_failed
-          @file # TODO: Why this? Shouldn't we just crash?
+          @file
         when :command_not_found
           fail CommandNotFoundError
       end
@@ -34,7 +44,7 @@ module PdfCover
       %W(-sOutputFile='#{destination}' -dNOPAUSE
          -sDEVICE='#{device}' -dJPEGQ=#{@quality}
          -dFirstPage=1 -dLastPage=1
-         -r300 -q '#{source}'
+         -r#{@resolution} -q '#{source}'
          -c quit
       ).join(" ")
     end
@@ -64,6 +74,16 @@ module PdfCover
       Kernel.system(command)
     end
 
+    def extract_options(options)
+      @format = options.fetch(:format, DEFAULT_FORMAT)
+      @quality = options.fetch(:quality, DEFAULT_QUALITY).to_i
+      @resolution = options.fetch(:resolution, DEFAULT_RESOLUTION).to_i
+
+      fail InvalidOption.new(:format, @format) unless %w(jpg jpeg png).include?(@format)
+      fail InvalidOption.new(:quality, @quality) unless @quality.between?(1, 100)
+      fail InvalidOption.new(:resolution, @resolution) unless @resolution > 1
+    end
+
     def failed_result(result)
       destination_file.close
 

data/lib/pdf_cover/version.rb

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

data/lib/pdf_cover.rb

@@ -29,8 +29,8 @@ module PdfCover
       #       pdf_cover_attachment
       #     end
       #   end
-      def pdf_cover_attachment
-        process :pdf_cover
+      def pdf_cover_attachment(options = {})
+        process pdf_cover: [options[:quality], options[:resolution]]
 
         define_method :full_filename do |for_file = model.logo.file|
           for_file.gsub(/pdf$/, "jpeg")
@@ -54,7 +54,7 @@ module PdfCover
       #     include PdfCover
       #
       #     pdf_cover_attachment :pdf, styles: { pdf_cover: ['', :jpeg]},
-      #       convert_options: { all: '-quality 95' }
+      #       convert_options: { all: '-quality 95 -density 300' }
       #
       #     # Note that you must set content type validation as required by Paperclip
       #     validates_attachment_content_type :pdf, content_type: %w(application/pdf)
@@ -89,9 +89,10 @@ module PdfCover
     end
   end
 
-  # This is the method used by the PaperClip processor mechanism
-  def pdf_cover
-    converted_file = PdfCover::Converter.new(file).converted_file
+  # This is the method used by the CarrierWave processor mechanism
+  def pdf_cover(quality, resolution)
+    options = { quality: quality, resolution: resolution }
+    converted_file = PdfCover::Converter.new(file, options).converted_file
     FileUtils.cp(converted_file, current_path)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_cover
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Juan González
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print