poleica 0.9.12 → 0.10.0

data/lib/poleica/converters/graphics_magick/thumbnail_options_generator.rb

@@ -0,0 +1,108 @@
+# -*- encoding: utf-8 -*-
+module Poleica
+  module Converters
+    class GraphicsMagick
+      # Generate options for the GraphicsMagick to_thumbnail
+      # @options page [Array, Integer]
+      class ThumbnailOptionsGenerator
+        include Poleica::Converters::Utils
+        attr_reader :polei, :options, :current_width,
+                    :current_height, :output_path
+
+        def initialize(polei, options = {})
+          @polei     = polei
+          @options   = default_options.merge(options)
+          @current_width, @current_height = identify
+        end
+
+        def generate
+          [
+            'convert',
+            "#{polei.path}[0]",
+            orient_options,
+            resize_options,
+            output_options
+          ].flatten
+        end
+
+        private
+
+        def default_options
+          {
+            height: DEFAULT_MEASURE,
+            width:  DEFAULT_MEASURE,
+            auto_orient: true
+          }
+        end
+
+        def orient_options
+          @orient_options ||= options[:auto_orient] ? '-auto-orient' : ''
+        end
+
+        def resize_options
+          @resize_options ||=
+            [
+              '-resize',
+              "#{width_and_height_options}"
+          ]
+        end
+
+        def width_and_height_options
+          if current_width >= current_height
+            width_only_option
+          else
+            height_only_option
+          end
+        end
+
+        def width_only_option
+          if percent(current_width, options[:width]) > 50
+            "#{options[:width]}!x"
+          else
+            "#{current_width}x#{current_height}"
+          end
+        end
+
+        def height_only_option
+          if percent(current_height, options[:height]) > 50
+            "x#{options[:height]}!"
+          else
+            "#{current_width}x#{current_height}"
+          end
+        end
+
+        def identify
+          line = exec_with_timeout(bin_path(GraphicsMagick), identify_options)
+          width, height = line.split.first.split('x')
+          [width.to_i, height.to_i]
+        end
+
+        def identify_options
+          [
+            'identify',
+            '-format',
+            '%wx%h ',
+            polei.path
+          ]
+        end
+
+        def percent(comparing, compared)
+          (comparing.to_f / compared.to_f) * 100
+        end
+
+        def output_options
+          @output_path = if options[:path]
+                           if File.directory?(options[:path])
+                             name = File.basename(polei.path_with_md5(:png))
+                             File.join(options[:path], name)
+                           else
+                             options[:path]
+                           end
+                         else
+                           polei.path_with_md5(:png)
+                         end
+        end
+      end # class ThumbnailOptionsGenerator
+    end # class GraphicsMagick
+  end # module Converters
+end # module Poleica

data/lib/poleica/converters/libre_office.rb

@@ -21,10 +21,10 @@ module Poleica
         opts_gen = OptionsGenerator.new(polei, options, :pdf)
         exec_with_timeout(bin_path, opts_gen.generate)
         expected_file_path = opts_gen[:path] || polei.path_with_md5(:pdf)
-        File.exists?(expected_file_path) ? expected_file_path : nil
+        File.exist?(expected_file_path) ? expected_file_path : nil
       ensure
         temp_file_path = opts_gen.temp_path
-        File.delete(temp_file_path) if File.exists?(temp_file_path)
+        File.delete(temp_file_path) if File.exist?(temp_file_path)
       end
 
       private
@@ -58,7 +58,7 @@ module Poleica
         # @return temp_path [String]
         def temp_path
           @temp_path ||= generate_temp_path
-          FileUtils.cp(polei.path, @temp_path) unless File.exists?(@temp_path)
+          FileUtils.cp(polei.path, @temp_path) unless File.exist?(@temp_path)
           @temp_path
         end
 
@@ -78,19 +78,19 @@ module Poleica
         end
 
         def pathable_object
-            pathable_object = Struct.new(:path).new(options[:path])
-            pathable_object.extend(Poleica::Pathable)
+          pathable_object = Struct.new(:path).new(options[:path])
+          pathable_object.extend(Poleica::Pathable)
         end
 
         def default_options
-          %w{
-             --nologo
-             --headless
-             --invisible
-             --norestore
-             --nolockcheck
-             --convert-to
-          }
+          %w(
+            --nologo
+            --headless
+            --invisible
+            --norestore
+            --nolockcheck
+            --convert-to
+          )
         end
 
         def output_options

data/lib/poleica/converters/utils.rb

@@ -6,7 +6,6 @@ module Poleica
   module Converters
     # An Utility module for the converters needs to be include
     module Utils
-
       HOST_OS ||= (defined?('RbConfig') ? RbConfig : Config)::CONFIG['host_os']
 
       def windows?
@@ -22,15 +21,15 @@ module Poleica
       end
 
       def host_os
-        [:windows, :osx, :linux].find { |os| self.send(:"#{os}?") }
+        [:windows, :osx, :linux].find { |os| send(:"#{os}?") }
       end
 
-      def bin_path
-        converter     = :"#{underscorize(self.class)}"
+      def bin_path(given_class = nil)
+        converter     = :"#{underscorize(given_class || self.class)}"
         configuration = Poleica.configuration.send(converter)
         bin_paths     = configuration[:bin_paths]
         path          = bin_paths[host_os] || bin_paths[:linux]
-        raise "#{self.class} not found @ #{path}" unless File.exists?(path)
+        fail "#{converter} not found @ #{path}" unless File.exist?(path)
         path
       end
 
@@ -50,24 +49,42 @@ module Poleica
         [extension, options]
       end
 
-      def exec_with_timeout(bin, args = [], timeout = nil, no_stdout = true)
-        args              = Array(args).map(&:to_s)
-        timeout         ||= Poleica.configuration.timeout
-        process           = ChildProcess.build(bin, *args)
-        set_process_stdout(process, no_stdout)
-        process.start
-        timeout ? process.poll_for_exit(timeout) : process.wait
+      def exec_with_timeout(bin, args = [], options = {})
+        timeout           = options[:timeout] || Poleica.configuration.timeout
+        process           = ChildProcess.build(bin, *Array(args).map(&:to_s))
+        map_std(process) do
+          process.start
+          timeout ? process.poll_for_exit(timeout) : process.wait
+        end
       rescue ChildProcess::TimeoutError => e
         process.stop
-        raise(Poleica::TimeoutError.new(e.message))
+        raise Poleica::TimeoutError, e.message
+      end
+
+      def map_std(process, &block)
+        stdout, stdout_w, stderr, stderr_w = init_process_std(process)
+        yield
+        stderr_w.close.nil? && fail_if_error(process, stderr)
+        stdout_w.close.nil? && stdout.read
+      ensure
+        stderr_w.close unless stderr_w.closed?
+        stdout_w.close unless stdout_w.closed?
+      end
+
+      def init_process_std(process)
+        stdout, stdout_w = IO.pipe
+        stderr, stderr_w = IO.pipe
+
+        process.io.stdout = stdout_w
+        process.io.stderr = stderr_w
+
+        [stdout, stdout_w, stderr, stderr_w]
       end
 
-      def set_process_stdout(process, no_stdout)
-        if no_stdout
-          null              = IO.new(IO.sysopen('/dev/null', 'w'), 'w')
-          process.io.stdout = process.io.stderr = null
-        else
-          process.io.inherit!
+      def fail_if_error(process, stderr)
+        unless process.exit_code == 0
+          message = "Code: #{process.exit_code} #{stderr.read}"
+          fail Poleica::ProcessError, message
         end
       end
     end # module Utils

data/lib/poleica/errors.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
 module Poleica
   class TimeoutError < StandardError;  end
+  class ProcessError < StandardError;  end
 end # module Poleica

data/lib/poleica/pathable.rb

@@ -7,11 +7,11 @@ module Poleica
     end
 
     def path_without_extension
-      File.join(File.dirname(self.path), File.basename(self.path, '.*'))
+      File.join(File.dirname(path), File.basename(path, '.*'))
     end
 
     def path_with_md5(extension = self.extension)
-      data   = File.read(self.path)
+      data   = File.read(path)
       md5    = Digest::MD5.new
       digest = md5.hexdigest(data)
       "#{path_without_extension}-#{digest}.#{extension}"

data/lib/poleica/polei.rb

@@ -10,7 +10,7 @@ module Poleica
 
     def initialize(path)
       @path = path.strip
-      raise "No file @ #{path}" unless File.exists?(path)
+      fail "No file @ #{path}" unless File.exist?(path)
     end
 
     def name

data/lib/poleica/types/archive.rb

@@ -6,7 +6,6 @@ module Poleica
       COMPATIBLE_MIMETYPES = [
         'application/zip' # .zip or a range of docs like .key, .pptx or .docx
       ]
-
     end # class Archive
   end # module Types
-end # module Poleica
+end # module Poleica

data/lib/poleica/types/document.rb

@@ -4,25 +4,25 @@ module Poleica
     # Document Type
     class Document
       COMPATIBLE_MIMETYPES = [
-        'applicationiapplication/vnd.oasis.opendocument.image', # .odi
-        'application/vnd.oasis.opendocument.presentation',      # .opd
-        'application/vnd.oasis.opendocument.text-master',       # .odm
-        'application/vnd.oasis.opendocument.spreadsheet',       # .ods
-        'application/vnd.oasis.opendocument.graphics',          # .odg
-        'application/vnd.oasis.opendocument.formula',           # .odf
-        'application/vnd.oasis.opendocument.chart',             # .odc
-        'application/vnd.oasis.opendocument.text',              # .odt
-        'application/vnd.ms-office',                            # .doc
-        'application/vnd.ms-excel',                             # .xls
-        'application/vnd.ms-office',                            # .ppt, .pps
-        'application/msword',                                   # .doc
-        'text/html',                                            # .html, .htm
-        'text/plain',                                           # .txt
-        'text/rtf'                                              # .rft
+        'application/vnd.oasis.opendocument.presentation',  # .opd
+        'application/vnd.oasis.opendocument.text-master',   # .odm
+        'application/vnd.oasis.opendocument.spreadsheet',   # .ods
+        'application/vnd.oasis.opendocument.graphics',      # .odg
+        'application/vnd.oasis.opendocument.formula',       # .odf
+        'application/vnd.oasis.opendocument.chart',         # .odc
+        'application/vnd.oasis.opendocument.image',         # .odi
+        'application/vnd.oasis.opendocument.text',          # .odt
+        'application/vnd.ms-office',                        # .doc
+        'application/vnd.ms-excel',                         # .xls
+        'application/vnd.ms-office',                        # .ppt, .pps
+        'application/msword',                               # .doc
+        'text/html',                                        # .html, .htm
+        'text/plain',                                       # .txt
+        'text/rtf'                                          # .rft
       ]
 
       # Unsupported :( : key, pages
-      COMPATIBLE_EXTENSIONS = %w{
+      COMPATIBLE_EXTENSIONS = %w(
         html
         htm
         odt
@@ -43,10 +43,9 @@ module Poleica
         pps
         txt
         rft
-      }
+      )
 
       def initialize(file_path)
-
       end
     end # class Document
   end # module Types

data/lib/poleica/types/general.rb

@@ -4,12 +4,10 @@ module Poleica
     # Null Object Pattern Type, this is the type returned if no compatible
     # types are found
     class General
-
       COMPATIBLE_MIMETYPES  = []
       COMPATIBLE_EXTENSIONS = []
 
       def initialize(file_path)
-
       end
     end # class General
   end # module Types

data/lib/poleica/types/image.rb

@@ -14,7 +14,7 @@ module Poleica
         'image/png'                # .png
       ]
 
-      COMPATIBLE_EXTENSIONS = %w{
+      COMPATIBLE_EXTENSIONS = %w(
         tiff
         jpeg
         ppm
@@ -27,10 +27,9 @@ module Poleica
         tif
         gif
         png
-      }
+      )
 
       def initialize(file_path)
-
       end
     end # class Image
   end # module Types

data/lib/poleica/types/pdf.rb

@@ -7,12 +7,11 @@ module Poleica
         'application/pdf' # pdf
       ]
 
-      COMPATIBLE_EXTENSIONS = %w{
+      COMPATIBLE_EXTENSIONS = %w(
         pdf
-      }
+      )
 
       def initialize(file_path)
-
       end
     end # class PDF
   end # module Types

data/lib/poleica/version.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# Poleica namespace
 module Poleica
-  VERSION ||= '0.9.12'
+  VERSION = '0.10.0'
 end # module Poleica

data/lib/poleica.rb

@@ -1,4 +1,6 @@
 # -*- encoding: utf-8 -*-
+# The Awesome Namespace
+# Poleica is a general converter
 module Poleica
   def self.new(file_or_path)
     file_or_path = file_or_path.path if file_or_path.respond_to?(:path)
@@ -20,8 +22,11 @@ require 'poleica/types/all'
 require 'poleica/converters/utils'
 require 'poleica/converters/general'
 require 'poleica/converters/coercive'
-require 'poleica/converters/graphics_magick'
 require 'poleica/converters/libre_office'
+require 'poleica/converters/graphics_magick/graphics_magick'
+require 'poleica/converters/graphics_magick/thumbnail_options_generator'
+require 'poleica/converters/graphics_magick/convert_options_generator'
+# /!\ Should be last converters
 require 'poleica/converters/convertible'
 
 require 'poleica/pathable'

data/poleica.gemspec

@@ -15,8 +15,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
   s.add_runtime_dependency     'childprocess'
-# s.add_runtime_dependency     'posix-spawn' ONLY MRI
 
   s.add_development_dependency 'bundler', '~> 1.3'
-  s.add_development_dependency 'rake'
 end

data/test/poleica/configuration_test.rb

@@ -5,9 +5,11 @@ class ConfigurationTest < Minitest::Test
   def test_timeout_configuration
     start_time = Time.now
     Poleica.configure { |config| config.timeout = 1 }
-    Poleica::Converters::Utils.exec_with_timeout('sleep 2') rescue nil
+    # rubocop:disable RescueModifier
+    Poleica::Converters::Utils.exec_with_timeout('sleep 10') rescue nil
+    # rubocop:enable
     duration = Time.now - start_time
-    assert(duration < 2)
+    assert(duration < 10)
   ensure
     Poleica.configure { |config| config.timeout = 120 }
   end

data/test/poleica/converters/coercive_test.rb

@@ -1,7 +1,6 @@
 # -*- encoding: utf-8 -*-
 require 'test_helper'
 # Test the Coercive Converter Module
-
 class CoerciveTest < Minitest::Test
   DOC_PATH = "#{Support.support_path}/files/example.doc"
 
@@ -18,13 +17,13 @@ class CoerciveTest < Minitest::Test
 
   def test_try_convert_intermediary_file_creation
     coercive_conv.send(:coerce, :to_png, {})
-    assert(File.exists?(expected_pdf_path))
+    assert(File.exist?(expected_pdf_path))
     clean_pdf_file
   end
 
   def test_try_convert_file_creation
     coercive_conv.send(:try_convert, :to_png)
-    assert(File.exists?(find_png_path))
+    assert(File.exist?(find_png_path))
     clean_png_file(find_png_path)
     clean_pdf_file
   end
@@ -32,7 +31,7 @@ class CoerciveTest < Minitest::Test
   def test_coercive_conversion
     polei = Poleica.new(DOC_PATH)
     returned_path = polei.to_png
-    assert(File.exists?(returned_path))
+    assert(File.exist?(returned_path))
     clean_png_file(find_png_path)
   end
 
@@ -45,11 +44,11 @@ class CoerciveTest < Minitest::Test
   private
 
   def clean_pdf_file
-    File.exists?(expected_pdf_path) && File.delete(expected_pdf_path)
+    File.exist?(expected_pdf_path) && File.delete(expected_pdf_path)
   end
 
   def clean_png_file(png_path = expected_png_path)
-    File.exists?(png_path) && File.delete(png_path)
+    File.exist?(png_path) && File.delete(png_path)
   end
 
   def expected_pdf_path

data/test/poleica/converters/graphics_magick_test.rb

@@ -2,7 +2,6 @@
 require 'test_helper'
 # Test the GraphicsMagick Converter Module
 class GraphicsMagickTest < Minitest::Test
-
   PDF_PATH = "#{Support.support_path}/files/example.pdf"
 
   def setup
@@ -18,7 +17,7 @@ class GraphicsMagickTest < Minitest::Test
 
   def test_to_png_create_a_file
     returned_path = pdf_polei.to_png
-    assert(returned_path && File.exists?(returned_path))
+    assert(returned_path && File.exist?(returned_path))
     clean_png_file
   end
 
@@ -26,31 +25,31 @@ class GraphicsMagickTest < Minitest::Test
     path_option   = "#{Support.support_path}/files/path_test.png"
     returned_path = pdf_polei.to_png(path: path_option)
     assert(returned_path)
-    assert(File.exists?(path_option))
-    assert(File.exists?(returned_path))
+    assert(File.exist?(path_option))
+    assert(File.exist?(returned_path))
     assert_equal(returned_path, path_option)
-    File.delete(path_option) if File.exists?(path_option)
+    File.delete(path_option) if File.exist?(path_option)
   end
 
   def test_to_png_path_with_spaces
     path_option   = "#{Support.support_path}/files/path with spaces.png"
     returned_path = pdf_polei.to_png(path: path_option)
     assert(returned_path)
-    assert(File.exists?(path_option))
-    assert(File.exists?(returned_path))
+    assert(File.exist?(path_option))
+    assert(File.exist?(returned_path))
     assert_equal(returned_path, path_option)
-    File.delete(path_option) if File.exists?(path_option)
+    File.delete(path_option) if File.exist?(path_option)
   end
 
   def test_path_folder
     path_option = '/tmp/'
-    expected_path = "/tmp/#{File.basename(pdf_polei.path_with_md5)}"
+    expected_path = "/tmp/#{File.basename(pdf_polei.path_with_md5(:png))}"
     returned_path = pdf_polei.to_png(path: path_option)
     assert(returned_path)
-    assert(File.exists?(expected_path))
-    assert(File.exists?(returned_path))
+    assert(File.exist?(expected_path))
+    assert(File.exist?(returned_path))
     assert_equal(expected_path, returned_path)
-    File.delete(expected_path) if File.exists?(expected_path)
+    File.delete(expected_path) if File.exist?(expected_path)
   end
 
   def test_force_resize_option
@@ -76,22 +75,40 @@ class GraphicsMagickTest < Minitest::Test
     clean_png_file
   end
 
-  def test_thumbnail_option
-    returned_path = pdf_polei.to_png(width: 100,
-                                     height: 100,
-                                     thumbnail: true)
-    expected_path = Support.expected_converted_path(PDF_PATH, :png)
-    bin_path = Poleica::Converters::GraphicsMagick.new(pdf_polei).bin_path
+  def test_thumbnail
+    path_option = "#{Support.support_path}/files/120x70.png"
+    polei       = Poleica::Polei.new(path_option)
+    returned_path = polei.to_thumbnail(width: 100,
+                                       height: 100)
+    expected_path = Support.expected_converted_path(path_option)
+    bin_path = Poleica::Converters::GraphicsMagick.new(polei).bin_path
     assert_equal(expected_path, returned_path)
     size = `#{bin_path} identify #{returned_path}`.split[2][/(\w)*/]
-    assert_equal('100x100', size)
-    clean_png_file
+    assert_equal('100x58', size)
+    if File.exist?(expected_path)
+      File.delete(expected_path)
+    end
+  end
+
+  def test_thumbnail_too_small
+    path_option = "#{Support.support_path}/files/30x30.png"
+    polei       = Poleica::Polei.new(path_option)
+    returned_path = polei.to_thumbnail(width: 100,
+                                       height: 100)
+    expected_path = Support.expected_converted_path(path_option)
+    bin_path = Poleica::Converters::GraphicsMagick.new(polei).bin_path
+    assert_equal(expected_path, returned_path)
+    size = `#{bin_path} identify #{returned_path}`.split[2][/(\w)*/]
+    assert_equal('30x30', size)
+    if File.exist?(expected_path)
+      File.delete(expected_path)
+    end
   end
 
   private
 
   def clean_png_file
-    if File.exists?(Support.expected_converted_path(PDF_PATH, :png))
+    if File.exist?(Support.expected_converted_path(PDF_PATH, :png))
       File.delete(Support.expected_converted_path(PDF_PATH, :png))
     end
   end

data/test/poleica/converters/libre_office_test.rb

@@ -2,7 +2,6 @@
 require 'test_helper'
 # Test the LibreOffice Converter Module
 class LibreOfficeTest < Minitest::Test
-
   DOC_PATH = "#{Support.support_path}/files/example.doc"
 
   def setup
@@ -18,7 +17,7 @@ class LibreOfficeTest < Minitest::Test
 
   def test_to_pdf_create_a_file
     returned_path = doc_polei.to_pdf
-    assert(returned_path && File.exists?(returned_path))
+    assert(returned_path && File.exist?(returned_path))
     clean_pdf_file
   end
 
@@ -26,25 +25,25 @@ class LibreOfficeTest < Minitest::Test
     path_option   = "#{Support.support_path}/files/path_test.pdf"
     returned_path = doc_polei.to_pdf(path: path_option)
     assert(returned_path)
-    assert(File.exists?(path_option))
-    assert(File.exists?(returned_path))
+    assert(File.exist?(path_option))
+    assert(File.exist?(returned_path))
     assert_equal(returned_path, path_option)
-    File.delete(path_option) if File.exists?(path_option)
+    File.delete(path_option) if File.exist?(path_option)
   end
 
   def test_path_folder
     path_option = '/tmp/'
     returned_path = doc_polei.to_pdf(path: path_option)
     assert(returned_path)
-    assert(File.exists?(path_option))
-    assert(File.exists?(returned_path))
+    assert(File.exist?(path_option))
+    assert(File.exist?(returned_path))
     assert_equal(returned_path, path_option)
   end
 
   private
 
   def clean_pdf_file
-    if File.exists?(Support.expected_converted_path(DOC_PATH, :pdf))
+    if File.exist?(Support.expected_converted_path(DOC_PATH, :pdf))
       File.delete(Support.expected_converted_path(DOC_PATH, :pdf))
     end
   end