pludoni_pdfutils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2d234dcf736cf33aab2fe4a858f41e35c25c62648cdddb73b8e25fe1f81a805
+  data.tar.gz: 6a76b1a8a6bda7e02fea6860f4efcce96c72174a1efcdfca8db3caf237a14d6a
+SHA512:
+  metadata.gz: 2f31fd04e951b53a70f0e44f18bfc24aeaf5b80385fe83a8faf219a55c34bd6bfa81868c7ecf2d2f75928364504588e9a1e1669811e3cd34f117c9fe8d6d2305
+  data.tar.gz: 9842f36bb4db2b57781a9445ec4da3fcceb2dd861e15c08d4e5f07f09613d82d2566e87feeb8417368a2f2ef30d7a68f365b9361ae119bdf43be0ae9cfecfa7b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pludoni-pdfutils.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    pludoni-pdfutils (0.1.0)
+      activestorage (>= 5.2.0)
+      mimemagic
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.7)
+      actionview (= 6.1.7)
+      activesupport (= 6.1.7)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.7)
+      activesupport (= 6.1.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7)
+      activesupport (= 6.1.7)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7)
+      activesupport (= 6.1.7)
+    activerecord (6.1.7)
+      activemodel (= 6.1.7)
+      activesupport (= 6.1.7)
+    activestorage (6.1.7)
+      actionpack (= 6.1.7)
+      activejob (= 6.1.7)
+      activerecord (= 6.1.7)
+      activesupport (= 6.1.7)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    marcel (1.0.2)
+    mimemagic (0.4.3)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    rake (13.0.6)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  pludoni-pdfutils!
+  rake
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Stefan Wienert
+
+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,53 @@
+# Pludoni::Pdfutils
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pludoni-pdfutils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pludoni-pdfutils
+
+requires ghostscript installed.
+
+## Usage
+
+All method take either ActiveStorage::Blob or File/Tempfile as argument and return a Tempfile/File
+
+```ruby
+# compresses the given file if larger than given max_size
+# @returns [Pludoni::Pdfutils::FileWrapper]
+Pludoni::Pdfutils.compress_if_large(file, max_size: 5.megabytes)
+
+# converts all images to pdf (keep pdf) and joins them if there are more than max_files
+# @param blobs [Array<ActiveStorage::Blob>]
+# @param max_files [Integer] keep max_files - 1 files, and join the rest
+# @param max_size [Integer] in bytes Convert individual file if larger than max_size
+# @returns [Array<Pludoni::Pdfutils::FileWrapper>]
+Pludoni::Pdfutils.convert_all_to_pdf_and_join_max_size(blobs, max_files: 3, max_size: 5.megabytes)
+```
+
+Individual classes:
+
+```ruby
+tempfile = Pludoni::Pdfutils::ConvertToPdf.new(image_file).run
+
+
+tempfile = Pludoni::Pdfutils::Joiner.new(job_application.uploads.map(&:blob)).run
+
+# compresses with Ghostscript + /ebook Profile
+tempfile = Pludoni::Pdfutils::Compressor.new(pdf_file).run
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pludoni/pdfutils"
+
+# 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(__FILE__)

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/pludoni/pdfutils/active_storage_wrapper.rb

@@ -0,0 +1,27 @@
+module Pludoni
+  module Pdfutils
+    class ActiveStorageWrapper < FileWrapper
+      def filesize
+        @file.byte_size
+      end
+
+      def to_tf
+        file = Tempfile.new(["ActiveStorage-#{@file.id}-", @file.filename.extension_with_delimiter])
+        ActiveStorage::Downloader.new(@file.service).send(:download, @file.key, file)
+        file
+      end
+
+      def filename
+        @file.filename.to_s
+      end
+
+      def open(&block)
+        @file.open(&block)
+      end
+
+      def content_type
+        @file.content_type
+      end
+    end
+  end
+end

data/lib/pludoni/pdfutils/compressor.rb

@@ -0,0 +1,23 @@
+require 'open3'
+
+module Pludoni::Pdfutils
+  class Compressor
+    def initialize(blob)
+      @blob = FileWrapper.make(blob)
+    end
+
+    def run
+      tf = Tempfile.new(['joiner', '.pdf'])
+      tf.binmode
+      input = @blob.to_tf
+      cli = "gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.4 -dPDFSETTINGS=/ebook -dNOPAUSE -dQUIET -dBATCH -sOutputFile=#{Shellwords.escape tf.path} #{Shellwords.escape input.path}"
+
+      stdout, stderr, status = Open3.capture3(cli)
+      unless status.success?
+        raise CompressionFailed, "PDF Compression failed: \nStdout: #{stdout}\nStderr: #{stderr}"
+      end
+
+      FileWrapper.make(tf)
+    end
+  end
+end

data/lib/pludoni/pdfutils/convert_to_pdf.rb

@@ -0,0 +1,25 @@
+require 'open3'
+
+module Pludoni::Pdfutils
+  class ConvertToPdf
+    def initialize(blob)
+      @blob = FileWrapper.make(blob)
+    end
+
+    def run(&block)
+      @blob.open do |source|
+        # convert image to pdf
+        tf = Tempfile.new(['convert', '.pdf'])
+        tf.binmode
+        cli = "gs -dNOSAFER -dPDFSETTINGS=/prepress -sDEVICE=pdfwrite -o #{tf.path} viewjpeg.ps -c \\(#{source.path}\\) viewJPEG"
+
+        stdout, stderr, status = Open3.capture3(cli)
+        unless status.success?
+          raise ConversionFailedError, "PDF convertion failed: Command: #{cli}\nStdout: #{stdout}\nStderr: #{stderr}"
+        end
+
+        FileWrapper.make(tf)
+      end
+    end
+  end
+end

data/lib/pludoni/pdfutils/file_wrapper.rb

@@ -0,0 +1,36 @@
+module Pludoni
+  module Pdfutils
+    class FileWrapper
+      def initialize(file)
+        @file = file
+      end
+
+      def self.make(blob_or_file)
+        case blob_or_file
+        when ActiveStorage::Blob
+          ActiveStorageWrapper.new(blob_or_file)
+        when File, Tempfile
+          LocalFileWrapper.new(blob_or_file)
+        when FileWrapper
+          blob_or_file
+        else
+          raise NotImplementedError, blob_or_file.class
+        end
+      end
+
+      def filesize
+        raise NotImplementedError
+      end
+
+      def open(&block)
+        raise NotImplementedError
+      end
+
+      def content_type
+        raise NotImplementedError
+      end
+    end
+  end
+end
+
+

data/lib/pludoni/pdfutils/joiner.rb

@@ -0,0 +1,23 @@
+require 'open3'
+
+module Pludoni::Pdfutils
+  class Joiner
+    def initialize(blobs)
+      @blobs = blobs.map { |i| FileWrapper.make(i) }
+    end
+
+    def run
+      tf = Tempfile.new(['joiner', '.pdf'])
+      tf.binmode
+      tfs = @blobs.map { |i| i.to_tf }
+      cli = "gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=#{tf.path} #{tfs.map(&:path).join(' ')}"
+
+        stdout, stderr, status = Open3.capture3(cli)
+      unless status.success?
+        raise JoiningFailedError, "PDF Joining failed: \nStdout: #{stdout}\nStderr: #{stderr}"
+      end
+
+      FileWrapper.make(tf)
+    end
+  end
+end

data/lib/pludoni/pdfutils/local_file_wrapper.rb

@@ -0,0 +1,28 @@
+module Pludoni
+  module Pdfutils
+    class LocalFileWrapper < FileWrapper
+      def filesize
+        @file.size
+      end
+
+      def filename
+        @file.path.split("/").last
+      end
+
+      def to_tf
+        @file.rewind
+        @file
+      end
+
+      def open(&block)
+        @file.open(&block)
+      end
+
+      def content_type
+        MimeMagic.by_magic(@file.read).type
+      ensure
+        @file.rewind
+      end
+    end
+  end
+end

data/lib/pludoni/pdfutils/version.rb

@@ -0,0 +1,5 @@
+module Pludoni
+  module Pdfutils
+    VERSION = "0.1.0"
+  end
+end

data/lib/pludoni/pdfutils.rb

@@ -0,0 +1,59 @@
+require "pludoni/pdfutils/version"
+require 'mimemagic'
+
+module Pludoni
+  module Pdfutils
+    class Error < StandardError; end
+    class JoiningFailedError < Error; end
+    class ConversionFailedError < Error; end
+    class CompressionFailed < Error; end
+
+    module_function
+
+    # compresses the given file if larger than given max_size
+    # @param file [File, Tempfile, ActiveStorage::Blob]
+    # @param max_size [Integer] in bytes
+    # @return [File, Tempfile]
+    def compress_if_large(file, max_size:)
+      file = FileWrapper.make(file)
+      if max_size && file.filesize > max_size
+        yield(file) if block_given?
+        Compressor.new(file).run
+      else
+        file
+      end
+    end
+
+    # converts all images to pdf and joins them if there are more than max_files
+    # @param blobs [Array<ActiveStorage::Blob>]
+    # @param max_files [Integer] keep max_files - 1 files, and join the rest
+    # @param max_size [Integer] in bytes Convert individual file if larger than max_size
+    def convert_all_to_pdf_and_join_max_size(blobs, max_files:, max_size: nil, &block)
+      files = blobs.map { |upload| convert_to_pdf(upload, &block) }
+      if files.length > max_files
+        if block_given?
+          yield("More than #{max_files}; joining, keeping first #{max_files - 1} files; joining the rest")
+        end
+        keep = files.take(max_files - 1)
+        join = Joiner.new(files.drop(max_files - 1)).run(&block)
+        files = keep + [join]
+      end
+      files.map do |file|
+        compress_if_large(file, max_size: max_size) do
+          yield("Compressing file") if block_given?
+        end
+      end
+    end
+
+    def convert_to_pdf(blob, &block)
+      blob = FileWrapper.make(blob)
+      # TODO: convert odt docx
+      if blob.content_type.to_s['image']
+        block.call("converting #{blob.filename.to_s} to pdf") if block_given?
+        ConvertToPdf.new(blob).run(&block)
+      else
+        blob
+      end
+    end
+  end
+end

data/lib/pludoni.rb

@@ -0,0 +1,2 @@
+module Pludoni
+end

data/lib/pludoni_pdfutils.rb

@@ -0,0 +1,8 @@
+require "zeitwerk"
+require 'pludoni'
+
+loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.ignore("#{ __FILE__ }")
+loader.setup
+
+require 'pludoni/pdfutils'

data/pludoni_pdfutils.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pludoni/pdfutils/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pludoni_pdfutils"
+  spec.version       = Pludoni::Pdfutils::VERSION
+  spec.authors       = ["Stefan Wienert"]
+  spec.email         = ["info@stefanwienert.de"]
+
+  spec.summary       = %q{Convert to pdf, compress pdf, join pdf using Ghostscript}
+  spec.description   = %q{Convert to pdf, compress pdf, join pdf using Ghostscript}
+  spec.homepage      = "https://github.com/pludoni/pdfutils"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activestorage", ">= 5.2.0"
+  spec.add_dependency "zeitwerk"
+  spec.add_dependency "mimemagic"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: pludoni_pdfutils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Convert to pdf, compress pdf, join pdf using Ghostscript
+email:
+- info@stefanwienert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pludoni.rb
+- lib/pludoni/pdfutils.rb
+- lib/pludoni/pdfutils/active_storage_wrapper.rb
+- lib/pludoni/pdfutils/compressor.rb
+- lib/pludoni/pdfutils/convert_to_pdf.rb
+- lib/pludoni/pdfutils/file_wrapper.rb
+- lib/pludoni/pdfutils/joiner.rb
+- lib/pludoni/pdfutils/local_file_wrapper.rb
+- lib/pludoni/pdfutils/version.rb
+- lib/pludoni_pdfutils.rb
+- pludoni_pdfutils.gemspec
+homepage: https://github.com/pludoni/pdfutils
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Convert to pdf, compress pdf, join pdf using Ghostscript
+test_files: []